mir/node-telegram-bot-api
2
0
Fork 0
mirror of https://github.com/yagop/node-telegram-bot-api synced 2025-08-29 05:17:41 +00:00
Code Issues Releases Wiki Activity

doc: Add docs on experimental features

Browse Source
This commit is contained in:
GochoMugo 2017-05-13 10:34:07 +03:00
parent a15e273bb9
commit 3d4d10f9b3
No known key found for this signature in database
GPG Key ID: 7B6A01CB57AA39E4
2 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -55,11 +55,14 @@ bot.on('message', (msg) => {
* [Usage][usage] * [Usage][usage]
* [Examples][examples] * [Examples][examples]
* [Help Information][help] * [Help Information][help]
* API Reference ([release][api-release] / [development][api-dev]) * API Reference ([release][api-release] / [development][api-dev] / [experimental][api-experimental])
* [Contributing to the Project][contributing] * [Contributing to the Project][contributing]
* [Experimental Features][experimental]
_**Note**: Development is done against the **master** branch.
Code for the latest release resides on the **release** branch
Experimental features reside on the **experimental** branch._
_**Note**: Development is done against the **master** branch. Code for the latest release
resides on the **release** branch._
## Community ## Community
@ -84,5 +87,7 @@ Copyright (c) 2017 Yago
[help]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/help.md [help]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/help.md
[api-dev]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/api.md [api-dev]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/api.md
[api-release]:https://github.com/yagop/node-telegram-bot-api/tree/release/doc/api.md [api-release]:https://github.com/yagop/node-telegram-bot-api/tree/release/doc/api.md
[api-experimental]:https://github.com/yagop/node-telegram-bot-api/tree/experimental/doc/api.md
[contributing]:https://github.com/yagop/node-telegram-bot-api/tree/master/CONTRIBUTING.md [contributing]:https://github.com/yagop/node-telegram-bot-api/tree/master/CONTRIBUTING.md
[experimental]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/experimental.md
[tg-channel]:https://telegram.me/node_telegram_bot_api [tg-channel]:https://telegram.me/node_telegram_bot_api

28
doc/experimental.md Normal file
View File

@ -0,0 +1,28 @@
# Experimental
Experimental features are things we are trying out. We are **not** sure
if they'll become stable and move into the `master` branch.
Try them out and give feedback to support stabilizing them.
* [Features](#features)
* [API Reference][api-experimental]
* [Installation](#installation)
<a name="features"></a>
## features:
* Support API method `deleteMessage`
Open issues tagged `experimental`: [link](https://github.com/yagop/node-telegram-bot-api/issues?q=is%3Apr+is%3Aopen+label%3Aexperimental)
<a name="installation"></a>
## installation:
```bash
$ npm install yagop/node-telegram-bot-api#experimental
```
[api-experimental]:https://github.com/yagop/node-telegram-bot-api/tree/experimental/doc/api.md