Wechaty is a Bot Framework for Wechat **Personal** Account, It can help you easy creating personal wechat bot in 7 lines of javascript code, with cross platform support to [linux](https://travis-ci.org/zixia/wechaty), [win32](https://ci.appveyor.com/project/zixia/wechaty) and [darwin(OSX/Mac)](https://travis-ci.org/zixia/wechaty).
Wechaty is a Bot Framework for Wechat **Personal** Account, It can help you easy creating personal wechat bot in 7 lines of javascript code, with cross platform support to [linux](https://travis-ci.org/wechaty/wechaty), [win32](https://ci.appveyor.com/project/zixia/wechaty) and [darwin(OSX/Mac)](https://travis-ci.org/wechaty/wechaty).
[](https://gitter.im/zixia/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://gitter.im/wechaty/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Wechaty is dead easy to use: 7 lines javascript for your wechat bot.
...
...
@@ -41,13 +41,13 @@ bot
Notice that you need to wait a moment while bot trys to get the login QRCode from Wechat. As soon as the bot gets login QRCode url, he will print url out. You need to scan the qrcode on wechat, and confirm login.
After that, bot will be on duty. (roger-bot source can be found at [here](https://github.com/zixia/wechaty/blob/master/example/roger-bot.js))
After that, bot will be on duty. (roger-bot source can be found at [here](https://github.com/wechaty/wechaty/blob/master/example/roger-bot.js))
## 2. Advanced: dozens of lines
Here's an chatbot [ding-dong-bot](https://github.com/zixia/wechaty/blob/master/example/ding-dong-bot.js) who can reply _dong_ when receives a message _ding_.
Here's an chatbot [ding-dong-bot](https://github.com/wechaty/wechaty/blob/master/example/ding-dong-bot.js) who can reply _dong_ when receives a message _ding_.
## 3. Hardcore: hundreds of lines
Here's a chatbot [api-ai-bot](https://github.com/zixia/wechaty/blob/master/example/api-ai-bot.js), who can slightly understand NLP.
Here's a chatbot [api-ai-bot](https://github.com/wechaty/wechaty/blob/master/example/api-ai-bot.js), who can slightly understand NLP.
Natual Language Understanding enabled by [api.AI](https://api.ai), you can get your module on api.AI by it's free plan.
...
...
@@ -57,18 +57,18 @@ Use docker to deploy wechaty is highly recommended.
Wechaty is fully dockerized. So it will be very easy to be deployed as a MicroService.
```shell
$ export TOKEN="your token here"
$ docker run -eWECHATY_TOKEN="$TOKEN"zixia/wechaty
$ docker run -eWECHATY_TOKEN="$TOKEN"wechaty/wechaty
```
`WECHATY_TOKEN` is required here, because you need this key to manage wechaty on the chatbot cloud manager: https://www.wechaty.io
...
...
@@ -122,7 +122,7 @@ Then you are set.
### 1. Open in Cloud9 IDE
Just one click here: <ahref="https://c9.io/open/?name=Wechaty&type=nodejs&clone_url=https://github.com/zixia/wechaty.git&description=Wechat%20for%20Bot&selection_file=/example/ding-dong-bot.js"target="_blank"><imgsrc="https://img.shields.io/badge/open%20in-Cloud9%20IDE-blue.svg"alt="Open Wechaty in Cloud9 IDE"></a>
Just one click here: <ahref="https://c9.io/open/?name=Wechaty&type=nodejs&clone_url=https://github.com/wechaty/wechaty.git&description=Wechat%20for%20Bot&selection_file=/example/ding-dong-bot.js"target="_blank"><imgsrc="https://img.shields.io/badge/open%20in-Cloud9%20IDE-blue.svg"alt="Open Wechaty in Cloud9 IDE"></a>
### 2. Set default to Node.js v6
Open Terminal in Cloud9 IDE, use nvm to install nodejs v6, which is required by Wechaty.
...
...
@@ -164,7 +164,7 @@ Node.js Version 6.0 or above is required.
If you have no github account, you can just clone it via https:
```shell
git clone https://github.com/zixia/wechaty.git
git clone https://github.com/wechaty/wechaty.git
```
This will clone wechaty source code to your current directory.
...
...
@@ -184,18 +184,18 @@ Please submit your issue if you have any, and a fork & pull is very welcome for
# Wechaty Badge
[](https://github.com/zixia/wechaty)
[](https://github.com/wechaty/wechaty)
## Markdown
```markdown
[](https://github.com/zixia/wechaty)
[](https://github.com/wechaty/wechaty)
<imgsrc="https://img.shields.io/badge/Powered%20By-Wechaty-green.svg?style=flat"alt="Powered by Wechaty"border="0">
</a>
```
...
...
@@ -214,7 +214,7 @@ To test with full log messages
$ WECHATY_LOG=silly npm test
```
[Details about unit testing](https://github.com/zixia/wechaty/tree/master/test)
[Details about unit testing](https://github.com/wechaty/wechaty/tree/master/test)
## LOG output
Wechaty use [npmlog](https://www.npmjs.com/package/npmlog) to output log message. You can set log level by environment variable `WECHATY_LOG` to show log message.
...
...
@@ -505,9 +505,10 @@ Know more about TAP: [Why I use Tape Instead of Mocha & So Should You](https://m
## v0.3.13 (master)
1. Managed by Cloud Manager: https://app.wechaty.io
1. Dockerized & Published to docker hub as: [zixia/wechaty](https://hub.docker.com/r/zixia/wechaty/)
1. add `reset` & `shutdown` to IO Event
1. Unit Test Runner switch from Tape/Tap to AVA <https://github.com/avajs/ava>
1. Dockerized & Published to docker hub as: [wechaty/wechaty](https://hub.docker.com/r/wechaty/wechaty/)
1. Add `reset` & `shutdown` to IO Event
1. Switch Unit Test Runner from Tape/Tap to [AVA](https://github.com/avajs/ava)
1. Move git resposity from zixia/wechaty to [wechaty/wechaty](https://github.com/wechaty/wechaty)
## v0.2.3 (2016/7/28)
1. add wechaty.io cloud management support: set environment variable `WECHATY_TOKEN` to enable io support
...
...
@@ -568,7 +569,7 @@ Know more about TAP: [Why I use Tape Instead of Mocha & So Should You](https://m
