diff --git a/README.md b/README.md index f573d7a..a95328d 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,14 @@ bot.on('message', (msg) => { * [Usage][usage] * [Examples][examples] * [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] +* [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 @@ -84,5 +87,7 @@ Copyright (c) 2017 Yago [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-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 +[experimental]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/experimental.md [tg-channel]:https://telegram.me/node_telegram_bot_api diff --git a/doc/experimental.md b/doc/experimental.md new file mode 100644 index 0000000..0dad2d6 --- /dev/null +++ b/doc/experimental.md @@ -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) + + + +## 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) + + + +## 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