doc: update doc

README.md

@@ -6,18 +6,14 @@
 
 ### 菜单和功能
 
-#### 交易列表
+#### 合约交易
 - 合约自动化交易的列表和配置
 - 支持每个币种的单独配置(合约模式,购买金额,合约倍率,是否开启)
 ![交易币种](./img/coins.jpg)
 ![钉钉推送1](./img/dingding.jpeg)
 
-#### 交易配置
-- 交易的基本相关的配置(conf)
-![交易配置](./img/config.jpg)
-
-#### 交易订单
-- 合约自动交易的订单历史(收益是预估与币安的实际收益会有稍微不同)
+#### 合约订单
+- 合约自动交易的订单历史(收益是根据下单预估的，没有查询币安的接口，与实际收益会有稍微不同)
 ![交易订单](./img/order.jpg)
 
 #### 新币抢购
@@ -27,29 +23,44 @@
 - 合约抢买做空
 ![新币抢购](./img/rush.jpg)
 
-#### 现货通知
+
+#### 币种通知
+##### 现货通知
 - 达到预设价格报警通知
 - 自动买入或卖出
 ![现货通知](./img/spot_notice.jpg)
 
-#### 合约通知
+##### 合约通知
 - 达到预设价格报警通知
 - 自动买入并自动挂止盈止损单
 ![合约通知](./img/feature_notice.jpg)
 
 
 #### 行情监听
+
+##### 现货监听
+- k线变化监听
+![现货监听](./img/listen_spot.jpg)
+
+##### 合约监听
 - k线变化监听
 - 肯纳特通道信号监听
+![合约监听](./img/listen_feature.jpg)
+![合约监听chart1](./img/listen_chat_kc.jpg)
+![合约监听通知1](./img/listen_dingding.jpg)
+
+#### 系统配置
+- 交易的基本相关的配置(conf)
+![交易配置](./img/config.jpg)
 
 ### 使用注意事项
-- 网络必须处于大陆之外(因为币安接口大陆正常无法访问), 已添加币安 api 的代理配置，如果有可用代理也可以正常使用
+- 网络必须处于大陆之外(因为币安接口大陆正常无法访问), 已添加币安 api 的代理配置(websocket 因为使用组件问题，暂无代理配置， websocket 只是用于后台更新合约币种最新价格)，如果有可用代理也可以正常使用
 - 申请api_key地址: [币安API管理页面](https://www.binance.com/cn/usercenter/settings/api-management)
-- 如果你的账号本身已经有合约仓位，请一定要在 `app.conf` 文件中配 `excludeSymbols`, 排出掉你不想使用本程序自动交易的币，否则默认所有的仓位都会根据交易策略规则自动平仓
+- 如果你的账号本身已经有合约仓位，请一定要在 `app.conf` 文件中配置 `excludeSymbols`, 排出掉你不想使用本程序自动交易的币，否则默认所有的仓位都会根据交易策略规则自动平仓
 - !!!注意修改app.conf配置后必须重新启动程序，否则配置不会生效!!!
-- 请保证账户有足够的 USDT
-- 钉钉推送 1min 中内不要超过 20 条，否则会被封 ip
-- 调整过大的参数可能会造成币安 api 请求频率超出限制，会禁用一段时间 ip
+- 请保证账户有足够的 USDT，否则下单会报错
+- 钉钉推送 1min 中内不要超过 20 条，否则会被封 ip 一段时间，无法推送成功
+- 调整过大的参数(例如同一个 ip 下使用多种组合功能)可能会造成币安 api 请求频率超出限制，会禁用一段时间 ip
 
 ### 相关技术指标函数
 >feature/strategy/line/technology.go
@@ -65,7 +76,7 @@ cp conf/app.conf.example conf/app.conf
 ```
 
 ##### 策略配置参数说明
-> 自动买卖的策略需要看代码自行分析，有好的思路这可以提供建议方案我来实现
+> 自动买卖的策略需要看代码自行分析，有好的思路可以提供建议方案我来实现
 
 ```
 [trade]
@@ -111,36 +122,41 @@ strategy_coin = coin5
 
 ### 新币抢购配置说明
 
-#### 币币抢买功能配置事例
+#### 币币抢买功能配置例子
 
 | 币种  |  买卖类型 | 类型  | usdt  |数量精度  | 开启  |
 | ------------ | ------------ | ------------ | ------------ | ------------ | ------------ |
 | ABCUSDT(切记带着USDT后缀)   | 买币  | 币币  | 10  |0.1(手动设定会减少一次api请求，不知道时设置为0会在上线时查询接口自动获取)   | 开启   |
 
-#### 币币挖矿抢卖功能配置事例
+#### 币币挖矿抢卖功能配置例子
 > ps: 如果挖矿的总价值小于5usdt，不能进行交易
 
 | 币种  |  买卖类型 | 类型  | 数量精度  | 卖出数量 | 开启  |
 | ------------ | ------------ | ------------ | ------------ | ------------ | ------------ |
 | ABCUSDT(切记带着USDT后缀)   | 卖币  | 币币  | 0.1(手动设定会减少一次api请求，不知道时设置为0会在上线时查询接口自动获取)   | 80(挖矿所得数量) |开启   |
 
-#### 合约抢买做多配置事例
+#### 合约抢买做多配置例子
 
 | 币种  |  买卖类型 | 类型  |模式| usdt|  倍率| 数量精度  |  开启  |
 | ------------ | ------------ | ------------ | ------------ | ------------ | ------------ |------------ | ------------ |
 | ABCUSDT(切记带着USDT后缀)   | 买币  | 合约  | 逐仓或全仓| 10|3 |0.1(手动设定会减少一次api请求，不知道时设置为0会在上线时查询接口自动获取)  |开启   |
 
-#### 合约抢买做空配置事例
+#### 合约抢买做空配置例子
 | 币种  |  买卖类型 | 类型  |模式| usdt|  倍率| 数量精度  |  开启  |
 | ------------ | ------------ | ------------ | ------------ | ------------ | ------------ |------------ | ------------ |
 | ABCUSDT(切记带着USDT后缀)   | 卖币  | 合约  | 逐仓或全仓| 10|3 |0.1(手动设定会减少一次api请求，不知道时设置为0会在上线时查询接口自动获取)  |开启   |
 
 
-
 ## 开发
 >安装最新版 golang
 
-### 安装bee
+## 配置文件
+
+```
+cp ./conf/app.conf.example app.conf
+```
+
+### 安装 bee
 > 记得将`GOPATH/bin`添加到环境变量`PATH`，否则 `bee` 命令无法全局使用
 > 使用 `go env GOPATH` 查看 `GOPATH` 路径
 
@@ -165,6 +181,8 @@ bee run
 ### 打包
 
 #### 打包到`windows`平台
+> 其它平台需要参考 bee 文档
+> 此项目的 github 的 workflows 实现了 linux amd64 和 window amd64 下的编译打包
 
 ```
 bee pack -be GOOS=windows