Browse Source

Add README

liuwons 9 years ago
parent
commit
1b7010d027
5 changed files with 34 additions and 3 deletions
  1. 1 1
      .gitignore
  2. 33 2
      README.md
  3. BIN
      img/1.png
  4. BIN
      img/backfront.jpg
  5. BIN
      img/send_msg.png

+ 1 - 1
.gitignore

@@ -61,5 +61,5 @@ target/
 #Ipython Notebook
 .ipynb_checkpoints
 
-*.jpg
+
 *.json

+ 33 - 2
README.md

@@ -1,2 +1,33 @@
-# wxBot
-WeChat robot written in Python
+# wxBot [![star this repo](http://github-svg-buttons.herokuapp.com/star.svg?user=liuwons&repo=wxBot&style=flat&background=1081C1)](http://github.com/liuwons/wxBot) [![fork this repo](http://github-svg-buttons.herokuapp.com/fork.svg?user=liuwons&repo=wxBot&style=flat&background=1081C1)](http://github.com/liuwons/wxBot/fork) ![python](https://img.shields.io/badge/python-2.7-ff69b4.svg)
+
+Python包装的网页微信API。可以很容易地实现微信机器人。
+
+## Dependencies
+程序用到了Python requests 和 pyqrcode库,使用之前需要安装这两个库:
+
+```bash
+pip install requests
+pip install pyqrcode
+```
+
+## Demo
+配置了 **[图灵机器人](http://www.tuling123.com/)** 之后,通过测试账号发送各种消息的效果:
+![向机器人发送消息](img/send_msg.png)
+![后台](img/backfront.jpg)
+
+
+## Run
+### 运行程序
+
+``` bash
+python wxbot.py
+```
+
+### 登录微信
+
+程序运行之后,会在当前目录下生成二维码图片文件 qr.jpg ,用微信扫描此二维码并按操作指示确认登录网页微信。可以选择是否自动回复。
+
+
+![1](img/1.png)
+
+按照操作指示在手机微信上扫描二维码然后登录,你可以选择是否开启自动回复模式。

BIN
img/1.png


BIN
img/backfront.jpg


BIN
img/send_msg.png