Add README in Chinese

README_zhCN.md

@@ -0,0 +1,188 @@
+# E5SubBot
+
+![](https://img.shields.io/github/go-mod/go-version/iyear/E5SubBot?style=flat-square)
+![](https://img.shields.io/badge/license-GPL-lightgrey.svg?style=flat-square)
+![](https://img.shields.io/github/v/release/iyear/E5SubBot?color=green&style=flat-square)
+
+[English](https://github.com/iyear/E5SubBot) | 简体中文
+
+A Simple Telebot for E5 Renewal
+
+`Golang` + `MySQL`
+
+DEMO: https://t.me/E5Sub_bot (长期运行，所有新功能会在DEMO测试)
+
+[交流群组](https://t.me/e5subbot)
+
+## 预览
+<center class="half">
+    <img src="https://raw.githubusercontent.com/iyear/E5SubBot/master/pics/bind.JPG" width="200"/><img src="https://raw.githubusercontent.com/iyear/E5SubBot/master/pics/my.JPG" width="200"/><img src="https://raw.githubusercontent.com/iyear/E5SubBot/master/pics/task.JPG" width="200"/>
+</center>
+
+## 特性
+
+- 自动续订E5订阅(可自定义的调用频率)
+- 可管理的简易账户系统
+- 完善的任务执行反馈
+- 极为方便的授权方式
+
+
+## 原理
+
+E5订阅为开发者订阅，只要调用相关API就有可能续期
+
+调用 [Outlook ReadMail API](https://docs.microsoft.com/zh-cn/graph/api/user-list-messages?view=graph-rest-1.0&tabs=http) 实现玄学的续订方式，不保证续订效果。
+
+## 使用方法
+
+1. 在机器人对话框输入 **/bind**
+2. 注册应用，使用E5主账号或同域账号登录，跳转页面获得client_secret。**点击回到快速启动**,获得client_id
+3. 复制client_secret和client_id，以 `client_id client_secret`格式回复
+4. 获得授权链接，使用E5主账号或同域账号登录
+5. 授权后会跳转至`http://localhost/e5sub……`  (会提示网页错误，复制链接即可)
+6. 复制整个浏览框内容，在机器人对话框回复 `链接+空格+别名(用于管理账户)`
+例如：`http://localhost/e5sub/?code=abcd MyE5`，等待机器人绑定后即完成
+
+## 自行部署
+
+Bot创建教程:[Google](https://www.google.com/search?q=telegram+Bot%E5%88%9B%E5%BB%BA%E6%95%99%E7%A8%8B)
+
+### Docker部署
+感谢 [@kzw200015](https://github.com/kzw200015) 提供`Dockerfile`以及`Docker`方面的帮助
+
+第一次启动不行，使用 `docker-compose restart`重启一次
+```bash
+mkdir ./e5bot && wget --no-check-certificate -O ./e5bot/config.yml https://raw.githubusercontent.com/iyear/E5SubBot/master/config.yml.example
+vi ./e5bot/config.yml
+wget --no-check-certificate https://raw.githubusercontent.com/iyear/E5SubBot/master/docker-compose.yml
+docker-compose up -d
+```
+### 二进制文件
+
+在[Releases](https://github.com/iyear/E5SubBot/releases)页面下载对应系统的二进制文件，上传至服务器
+
+Windows: 在`cmd`中启动 `E5SubBot.exe`
+
+Linux: 
+
+```bash
+screen -S e5sub
+chmod 773 E5SubBot
+./E5SubBot
+(Ctrl A+D)
+```
+### 编译
+
+下载源码，安装GO环境
+
+```shell
+go build
+```
+
+## 部署配置
+
+在同目录下创建`config.yml`，编码为`UTF-8`
+
+配置模板:
+
+```yaml
+bot_token: YOUR_BOT_TOKEN
+socks5: 127.0.0.1:1080
+notice: "第一行\n第二行"
+admin: 66666,77777,88888
+errlimit: 5
+cron: "1 */3 * * *"
+bindmax: 3
+mysql:
+  host: 127.0.0.1
+  port: 3306
+  user: e5sub
+  password: e5sub
+  database: e5sub
+```
+
+`bindmax`,`notice`,`admin`,`errlimit`可热更新，直接更新`config.yml`保存即可
+|  配置项   | 说明  |
+|  ----  | ----  |
+| bot_token  | 更换为自己的`BotToken` |
+| socks5  | `Socks5`代理,不需要删去即可.例如:`127.0.0.1:1080` |
+|notice|公告.合并至`/help`|
+|admin|管理员`tgid`，前往https://t.me/userinfobot获取，用`,`隔开;管理员权限: 手动调用任务，获得任务总反馈|
+|errlimit|单账户最大出错次数，满后自动解绑单账户并发送通知，不限制错误次数将值改为负数`(-1)`即可;bot重启后会清零所有错误次数|
+|cron|API调用频率，使用cron表达式|
+|bindmax|最大可绑定数|
+|mysql|mysql配置，请提前创建数据库|
+
+### 命令
+```
+/my 查看已绑定账户信息  
+/bind  绑定新账户  
+/unbind 解绑账户  
+/export 导出账户信息(JSON格式) 
+/help 帮助  
+/task 手动执行一次任务(Bot管理员)  
+/log 获取最近日志文件(Bot管理员)  
+```
+## 注意事项
+> 更新时间与北京时间不符
+
+更改服务器时区为`Asia/Shanghai`，然后使用`/task`手动执行一次任务刷新时间
+
+> 绑定格式错误
+
+不要带"+"号
+
+> 错误:Can't create more than max_prepared_stmt_count statements (current value: 16382)
+
+没有关闭`db`导致触发`mysql`并发上限，请更新至`v0.1.9`
+
+> 长时间运行崩溃
+
+疑似内存泄露，尚未解决，请自行采用守护进程运行或定时重启`Bot`
+
+## 做出贡献
+- 提供其他语言的文档
+- 为代码运行提供帮助
+- 对用户交互提出建议
+- ……
+## 小总结
+#### 得到了什么？
+- git的基本操作:add,commit,pull,push.但是对代码合并与冲突解决没有得到足够的实践和深入  
+- github版本库方面的使用(issue,pull request...),还有一些没玩过
+- 体验了Docker Hub 的自动构建
+- sql的CRUD，但都只是浮于表面，有时间再去琢磨
+- telegram bot的golang基本框架和一些有意思的玩法
+- 一些著名第三方库(viper,gjson)的基本用法
+- docker以及docker-compose的基本用法
+- 一些工具:gox;goreleaser的基本用法
+- ……
+#### 还缺点什么？
+
+- 对`CGO`知难而退，编译各种出错。下个项目如果用到`sqlite`一定解决`CGO`交叉编译
+- `DockerFile` 还不会写
+- 对项目的概念和意识不太行，目录太乱，随缘写全局变量
+- 看`telebot`的文档还好，看`stackflow` 只能看看代码。搜索还是习惯性带中文导致`stackflow`很难出现，降低了解决问题的效率
+
+#### 最后
+
+从2020.3.28开发至2020.4.12，一共经历14天，利用课余时间最终完成。
+
+就要开学了，因为马上步入高三，学习紧迫，遂不再进行功能开发。
+
+项目差不多就停更了，最多也就是每个星期看看issue、tg群组，修一修bug
+
+**DEMO依旧能保持服务水平，不会因为个人问题在这段时间停止运行**
+
+如果一年后还有人在用，一定会继续
+
+## Third-Party
+- [telebot](https://gopkg.in/tucnak/telebot)
+- [mysql_driver](https://github.com/go-sql-driver/mysql)
+- [gjson](https://github.com/tidwall/gjson)
+- [cron](https://github.com/robfig/cron/)
+- [viper](https://github.com/spf13/viper)
+- [goreleaser](https://https://github.com/goreleaser/goreleaser)
+
+## License
+
+GPLv3