documentation

This commit is contained in:
Mahdi Dibaiee 2015-06-29 03:24:41 +04:30
parent 875157a1cf
commit 7174ad30b1

View File

@ -8,6 +8,8 @@ for any bugs you find or any suggestions you have.
npm install telegram-api npm install telegram-api
``` ```
The code is well documented. I'm trying to integrate JSDoc / ESDoc into our repository for an easy to access documentation.
# Example # Example
Take a look at [demo.js](https://github.com/mdibaiee/node-telegram-api/blob/master/demo.js). Take a look at [demo.js](https://github.com/mdibaiee/node-telegram-api/blob/master/demo.js).
@ -87,4 +89,4 @@ This will result in:
- [ ] Location Type - [ ] Location Type
- [ ] Contact Type - [ ] Contact Type
- [ ] Allow remote control of bots (TCP maybe) - [ ] Allow remote control of bots (TCP maybe)
- YOUR IDEAS! [Fill an issue](https://github.com/mdibaiee/node-telegram-api/issues) - [ ] YOUR IDEAS! [Fill an issue](https://github.com/mdibaiee/node-telegram-api/issues)