From 3b96314e5d00b4a5de102dd7c809cfdd9018e525 Mon Sep 17 00:00:00 2001 From: yago Date: Mon, 29 Jun 2015 22:37:38 +0200 Subject: [PATCH] Updated README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 9432040..e3c27a8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ [![Build Status](https://travis-ci.org/yagop/telegram-bot-api.svg?branch=master)](https://travis-ci.org/yagop/telegram-bot-api) [![Coverage Status](https://coveralls.io/repos/yagop/telegram-bot-api/badge.svg?branch=develop)](https://coveralls.io/r/yagop/telegram-bot-api?branch=develop) +Node.js module to interact with official [Telegram Bot API](https://core.telegram.org/bots/api). A bot token is needed, to obtain one, talk to [@botfather](telegram.me/BotFather) and create a new bot. + +Both request method to obtain messages are implemented. To use standard polling, set `polling: true` +on `options`. Notice that [webHook](https://core.telegram.org/bots/api#setwebhook) will need a valid (not self signed) SSL certificate. + ```sh npm install node-telegram-bot-api ``` @@ -18,6 +23,8 @@ bot.on('message', function (msg) { }); ``` +There are some other examples on [examples](https://github.com/yagop/node-telegram-bot-api/tree/master/examples). + * * * ## Class: TelegramBot