From ff5492e93e46358a9a80f3d2dcc8748c7175b17f Mon Sep 17 00:00:00 2001
From: abelzhu <shengbenzhu@gmail.com>
Date: Sat, 28 Apr 2018 11:34:21 +0800
Subject: [PATCH] add readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++---
 1 file changed, 37 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index c5b962e..04d869e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,38 @@
-# weworkapi_python
-official lib of wework api https://work.weixin.qq.com/api/doc
 
-python 版企业微信API的使用demo
+# About
+weworkapi_python 是为了简化开发者对企业微信API接口的使用而设计的，API调用库系列之python版本      
+本库仅做示范用，并不保证完全无bug；另外，作者会不定期更新本库，但不保证与官方API接口文档同步，因此一切以[官方文档](https://work.weixin.qq.com/api/doc)为准。
+
+# Director 
+
+├── api // API 接口  
+│   ├── examples // API接口的测试用例  
+│   ├── README.md  
+│   └── src // API接口的关键逻辑  
+├── conf.py  
+├── README.md  
+
+# Usage
+将本项目下载到你的目录，既可直接引用相关文件  
+详细使用方法参考examples路径下的测试用例
+
+# 关于token的缓存
+token是需要缓存的，不能每次调用都去获取token（否者会中频率限制）  
+在本库的设计里，token是以类里的一个变量缓存的  
+比如api/src/CorpApi.py 里的access_token变量  
+在类的生命周期里，这个accessToken都是存在的， 当且仅当发现token过期，CorpAPI类会自动刷新token   
+刷新机制在 api/src/AbstractApi.py
+所以，使用时，只需要全局实例化一个CorpAPI类，不要析构它，就可一直用它调函数，不用关心 token  
+```
+api = CorpAPI(corpid, corpsecret);
+api.dosomething()
+api.dosomething()
+api.dosomething()
+....
+```
+当然，如果要更严格的做的话，建议自行修改，全局缓存token，比如存redis、存文件等，失效周期设置为2小时。
+
+# Contact us
+abelzhu@tencent.com  
+
+#