-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,68 @@ | ||
# wechaty-puppet-hostie | ||
|
||
[](https://www.npmjs.com/package/wechaty-puppet-hostie) | ||
 | ||
[](https://greenkeeper.io/) | ||
|
||
 | ||
|
||
Hostie Puppet for Wechaty | ||
|
||
## Features | ||
|
||
1. Consume hostie service | ||
1. Provide hostie service | ||
|
||
## Usage | ||
|
||
```ts | ||
import { Wechaty } from 'wechaty' | ||
|
||
const wechaty = new Wechaty({ | ||
puppet: 'wechaty-puppet-hostie', | ||
puppetOptions: { | ||
token: 'secret' | ||
} | ||
}) | ||
|
||
wechaty.start() | ||
``` | ||
|
||
## Environment Variables | ||
|
||
### 1 `WECHATY_PUPPET_HOSTIE_TOKEN' | ||
|
||
The token set to this environment variable will become the default value of `puppetOptions.token` | ||
|
||
```sh | ||
WECHATY_PUPPET_HOSTIE_TOKEN=secret node bot.js | ||
``` | ||
|
||
## History | ||
|
||
### master | ||
|
||
### v0.3 (Feb 2020) | ||
|
||
1. Publish the NPM module [wechaty-puppet-hostie](https://www.npmjs.com/package/wechaty-puppet-hostie) | ||
1. Implemented basic hostie features with gRPC module: [@chatie/grpc](https://github.com/Chatie/grpc) | ||
|
||
### v0.0.1 (Jun 2018) | ||
|
||
Designing the puppet hostie with the following protocols: | ||
|
||
1. [gRPC](https://grpc.io/) | ||
1. [JSON RPC](https://www.jsonrpc.org/) | ||
1. [OpenAPI/Swagger](https://swagger.io/docs/specification/about/) | ||
|
||
## Author | ||
|
||
[Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia)) [email protected] | ||
|
||
[](https://stackexchange.com/users/265499) | ||
|
||
## Copyright & License | ||
|
||
* Code & Docs © 2018-now Huan LI \<[email protected]\> | ||
* Code released under the Apache-2.0 License | ||
* Docs released under Creative Commons |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.