add new docs

haxor337 · Feb 27, 2019 · 086e872 · 086e872
1 parent d7e5b2b
commit 086e872
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/market.md b/docs/market.md
@@ -36,7 +36,14 @@ market.subscribe(const.MARKET_TYPE_ORDERBOOK, const.BINANCE, "ETH/BTC", on_event
 market.unsubscribe(const.MARKET_TYPE_ORDERBOOK, const.BINANCE, "ETH/BTC")
 ```
 
-> 使用同样的方式，可以订阅 KLine(const.MARKET_TYPE_KLINE)、Trade(const.MARKET_TYPE_TRADE)、Ticker(const.MARKET_TYPE_TICKER);
+> 使用同样的方式，可以订阅任意的行情
+```python
+from quant import const
+
+const.MARKET_TYPE_KLINE  # K线(KLine)
+const.MARKET_TYPE_TRADE  # 实时成交(Trade)
+const.MARKET_TYPE_TICKER  # 实时挂单(Ticker)
+```
 
 
 ### 行情数据结构

diff --git a/example/README.md b/example/README.md
@@ -1,6 +1,14 @@
 
 ## Demo使用示例
 
+本示例策略简单实现了在币安(Binance)交易所的订单薄买盘挂单吃毛刺的功能。  
+策略首先订阅了 `ETH/BTC` 的订单薄实时行情，并实时计算买3(bid3)和买4(bid4)的价格，然后计算买3个买4的平均价格(price = (bid3+bid4)/2)，
+同时判断是否已经有挂单。如果已经挂单，那么判断挂单价格是否超过当前bid3和bid4的价格区间，如果超过那么就撤单之后重新下单；如果没有挂单，那么
+直接使用price挂单。
+
+> 示例策略只是简单演示本框架的使用方法，策略本身还需要进一步优化，比如成交之后的追单，或对冲等。
+
+
 #### 推荐创建如下结构的文件及文件夹:
 ```text
 ProjectName