thereadme/node-telegram-api
1
0
Fork 0
Code Issues 9 Pull Requests Projects Releases Wiki Activity

Explain API, etc

Browse Source
This commit is contained in:
Mahdi Dibaiee 2015-06-30 04:24:32 +04:30
parent 53d2af4239
commit 13b162d274
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,6 +10,18 @@ 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. The code is well documented. I'm trying to integrate JSDoc / ESDoc into our repository for an easy to access documentation.
All Telegram API methods are accessible through `api` property of bots.
```javascript
bot.api.sendPhoto({
chat_id: 99999,
photo: 'some_id',
caption: 'dancing monkey'
});
```
Some API methods have been simplified using what we call *types*. See the example below.
# Example # Example
[@JavaScriptBot](https://telegram.me/JavaScriptBot) runs on `demo.js`, you can test it. [@JavaScriptBot](https://telegram.me/JavaScriptBot) runs on `demo.js`, you can test it.