docs

jzj1993 · Dec 28, 2018 · 13acec2 · 13acec2
1 parent 87bb1fb
commit 13acec2
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 3 deletions.
diff --git a/README-en.md b/README-en.md
@@ -17,7 +17,7 @@ Publish Markdown is an open source tool for publishing local markdown files to b
 
 ## Usage
 
-After downloading and installing, please see the welcome page for details.
+After [downloading](https://github.com/jzj1993/PublishMarkdown/releases) and installing, please see the welcome page for details.
 
 ## Related Articles
 
@@ -26,3 +26,24 @@ After downloading and installing, please see the welcome page for details.
 ## Contributing
 
 [Pull requests](https://github.com/jzj1993/PublishMarkdown/pulls) and stars are always welcome. For bugs and feature requests, please create an [issue](https://github.com/jzj1993/PublishMarkdown/issues).
+
+This project is build on [electron-vue](https://github.com/SimulatedGREG/electron-vue).
+
+Setting up the environment:
+
+```bash
+git clone [email protected]:jzj1993/PublishMarkdown.git
+cd PublishMarkdown
+yarn
+yarn dev
+```
+
+## Screenshots
+
+![](docs/screenshot-1.png)
+![](docs/screenshot-2.png)
+![](docs/screenshot-3.png)
+![](docs/screenshot-4.png)
+![](docs/screenshot-5.png)
+![](docs/screenshot-6.png)
+![](docs/screenshot-7.png)
diff --git a/README.md b/README.md
@@ -17,12 +17,33 @@ Publish Markdown是一款将本地Markdown文件发布到博客的开源工具
 
 ## 使用说明
 
-下载安装后，详见欢迎页说明。
+[下载](https://github.com/jzj1993/PublishMarkdown/releases)安装后，详见欢迎页说明。
 
 ## 相关文章
 
 [WordPress+Markdown+为知笔记，实现高质量笔记和博客](http://www.paincker.com/wp-markdown-wiz-blog)
 
-## 其他
+## 参与完善本工具
 
 欢迎提交[PullRequest](https://github.com/jzj1993/PublishMarkdown/pulls)和Star。有任何疑问和建议，可在GitHub创建[Issue](https://github.com/jzj1993/PublishMarkdown/issues)。
+
+工程基于[electron-vue](https://github.com/SimulatedGREG/electron-vue)搭建。
+
+环境配置：
+
+```bash
+git clone [email protected]:jzj1993/PublishMarkdown.git
+cd PublishMarkdown
+yarn
+yarn dev
+```
+
+## 屏幕截图
+
+![](docs/screenshot-1.png)
+![](docs/screenshot-2.png)
+![](docs/screenshot-3.png)
+![](docs/screenshot-4.png)
+![](docs/screenshot-5.png)
+![](docs/screenshot-6.png)
+![](docs/screenshot-7.png)
diff --git a/docs/screenshot-1.png b/docs/screenshot-1.png
diff --git a/docs/screenshot-2.png b/docs/screenshot-2.png
diff --git a/docs/screenshot-3.png b/docs/screenshot-3.png
diff --git a/docs/screenshot-4.png b/docs/screenshot-4.png
diff --git a/docs/screenshot-5.png b/docs/screenshot-5.png
diff --git a/docs/screenshot-6.png b/docs/screenshot-6.png
diff --git a/docs/screenshot-7.png b/docs/screenshot-7.png