🌐 Add README in English #30

README.md

@@ -25,21 +25,158 @@
 <a title="Author GitHub Followers" target="_blank" href="https://github.com/88250"><img src="https://img.shields.io/github/followers/88250.svg?label=Followers&style=social"></a>
 </p>
 
-* [B3log 构思 - 分布式社区网络](https://hacpai.com/article/1546941897596)
-* [Pipe 用户指南](https://hacpai.com/article/1513761942333)
-* [Pipe 开发指南](https://hacpai.com/article/1533965022328)
-* [Pipe 主题开发指南](https://hacpai.com/article/1512550354920)
+## 💡 简介
 
-欢迎关注 B3log 开源社区微信公众号 `B3log开源`：
+[Pipe](https://github.com/88250/pipe) 是一款小而美的开源博客平台，专为程序员设计。Pipe 有着非常活跃的[社区](https://hacpai.com)，可将文章作为帖子推送到社区，来自社区的回帖将作为博客评论进行联动（具体细节请浏览 [B3log 构思 - 分布式社区网络](https://hacpai.com/article/1546941897596)）。
 
-![image-d3c00d78](https://user-images.githubusercontent.com/873584/71566370-0d312c00-2af2-11ea-8ea1-0d45d6f0db20.png)
+> 这是一种全新的网络社区体验，让热爱记录和分享的你不再感到孤单！
 
-![start](https://user-images.githubusercontent.com/970828/71305910-71c6f980-2415-11ea-9ce1-657517a7858a.png)
+欢迎到 [Pipe 官方讨论区](https://hacpai.com/tag/pipe)了解更多。同时也欢迎关注 B3log 开源社区微信公众号 `B3log开源`：
+
+![b3logos.png](https://img.hacpai.com/file/2019/10/image-d3c00d78.png)
+
+## 🗃 案例
+
+* [Vanessa](http://vanessa.b3log.org)
+* [黑壳博客](http://blog.bhusk.com)
+* [zorke 的博客](https://www.zorkelvll.cn)
+* [Akkuman 的博客](http://o0o.pub)
+* [一个码农](http://blog.gitor.org)
+
+## ✨ 功能
+
+* 多用户博客平台
+* [Markdown 编辑器](https://github.com/Vanessa219/vditor)支持三种编辑模式：所见即所得 / 即时渲染 / 分屏预览
+* 聚合分类 / 标签
+* 自定义导航
+* 多主题 / 多语言
+* Atom / RSS / Sitemap
+* 文章搜索
+* Hexo/Jekyll 导入 / 导出
+* 可配置动静分离
+* 支持 SQLite / MySQL
+
+## 🎨 界面
+
+### 开始使用
+
+![start](https://user-images.githubusercontent.com/873584/56882188-78bf8700-6a95-11e9-9aab-841340d809ea.png)
+
+### 管理后台
 
 ![console](https://user-images.githubusercontent.com/873584/56882183-7826f080-6a95-11e9-92ab-447c8f05c1ac.png)
 
+### 编辑文章
+
 ![post](https://user-images.githubusercontent.com/873584/56882187-78bf8700-6a95-11e9-9147-822df8a32ffc.png)
 
+### 主题选择
+
 ![theme](https://user-images.githubusercontent.com/873584/56882189-78bf8700-6a95-11e9-8b63-ab1f3a8b9a21.png)
 
+### 主题 Gina
+
 ![gina](https://user-images.githubusercontent.com/873584/56882185-7826f080-6a95-11e9-9809-79a6eaaf784c.png)
+
+## 🛠️ 安装
+
+### 本地试用
+
+* [下载](https://github.com/88250/pipe/releases)最新的发布包解压，进入解压目录运行 pipe/pipe.exe
+* 从源码构建可参考[这里](https://hacpai.com/article/1533965022328)
+
+**请注意**：我们不建议通过发布包或者源码构建部署，因为这样的部署方式在将来有新版本发布时升级会比较麻烦。
+这两种方式请仅用于本地试用，线上生产环境建议通过 Docker 部署。
+
+### Docker 部署
+
+获取最新镜像：
+
+```shell
+docker pull b3log/pipe
+```
+
+* 使用 MySQL
+  先手动建库（库名 `pipe` ，字符集使用 `utf8mb4` ，排序规则 `utf8mb4_general_ci` ），然后启动容器：
+
+  ```shell
+  docker run --detach --name pipe --network=host \
+      b3log/pipe --mysql="root:123456@(127.0.0.1:3306)/pipe?charset=utf8mb4&parseTime=True&loc=Local&timeout=1s" --runtime_mode=prod --port=5897 --server=http://localhost:5897
+  ```
+
+
+  为了简单，使用了主机网络模式来连接主机上的 MySQL。
+* 使用 SQLite
+
+  ```shell
+  docker run --detach --name pipe --volume ~/pipe.db:/opt/pipe/pipe.db --publish 5897:5897 \
+      b3log/pipe --sqlite="/opt/pipe/pipe.db" --runtime_mode=prod --port=5897 --server=http://localhost:5897
+  ```
+
+启动参数说明：
+
+* `--port` ：进程监听端口
+* `--server` ：访问时的链接
+
+完整启动参数的说明可以使用 `-h` 来查看。
+
+### Docker 升级
+
+1. 拉取最新镜像
+2. 重启容器
+
+可参考[这里](https://github.com/88250/pipe/blob/master/docker-restart.sh)编写一个重启脚本，并通过 crontab 每日凌晨运行来实现自动更新。
+
+### NGINX 反代
+
+```
+upstream pipe {
+    server localhost:5897;
+}
+
+server {
+    listen 80;
+    server_name pipe.b3log.org; # 配置为你自己的域名
+
+    location / {
+        proxy_pass http://pipe$request_uri;
+        proxy_set_header  Host $host:$server_port;
+        proxy_set_header  X-Real-IP  $remote_addr;
+        client_max_body_size  10m;
+    }
+}
+```
+
+另外，可以参考 https://hacpai.com/article/1517474627971 进行配置。
+
+## 📜 文档
+
+* [《提问的智慧》精读注解版](https://hacpai.com/article/1536377163156)
+* [用户指南](https://hacpai.com/article/1513761942333)
+* [开发指南](https://hacpai.com/article/1533965022328)
+* [主题开发指南](https://hacpai.com/article/1512550354920)
+* [贡献指南](https://github.com/88250/pipe/blob/master/CONTRIBUTING.md)
+* [Postman 测试集](https://www.getpostman.com/collections/900ddef64ad0e60479a6)
+
+## 🏘️ 社区
+
+* [讨论区](https://hacpai.com/tag/pipe)
+* [报告问题](https://github.com/88250/pipe/issues/new/choose)
+
+## 📄 授权
+
+Pipe 使用 [木兰宽松许可证, 第2版](http://license.coscl.org.cn/MulanPSL2) 开源协议。
+
+## 🙏 鸣谢
+
+* [jQuery](https://github.com/jquery/jquery)：JavaScript 工具库，用于主题页面
+* [Vue.js](https://github.com/vuejs/vue)：渐进式 JavaScript 框架
+* [Nuxt.js](https://github.com/nuxt/nuxt.js)：Vue.js 框架
+* [Vuetify](https://github.com/vanessa219/vuetify)：Vue.js 的 Material 组件框架
+* [Vditor](https://github.com/Vanessa219/vditor)： 浏览器端的 Markdown 编辑器
+* [Gin](https://github.com/gin-gonic/gin)：又快又好用的 golang HTTP Web 框架
+* [GORM](https://github.com/jinzhu/gorm)：极好的 golang ORM 库
+* [SQLite](https://www.sqlite.org)：使用广泛的嵌入式 SQL 引擎
+* [GCache](https://github.com/bluele/gcache)：golang 缓存库
+* [Gulu](https://github.com/88250/gulu)：Go 语言常用工具库，这个轱辘还算圆
+* [Lute](https://github.com/88250/lute)：一款结构化的 Markdown 引擎，支持 Go 和 JavaScript