aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Kummerlaender2016-03-17 21:19:58 +0100
committerAdrian Kummerlaender2016-03-17 21:19:58 +0100
commit453f7779786962c86edd02466f02ba4a4acdf301 (patch)
treec7cfc84781da7549f7583dee657f53771df286b5
parent151b013ce874e9591bfadeeeb2afcc4b25d2344f (diff)
downloadTelebot-453f7779786962c86edd02466f02ba4a4acdf301.tar
Telebot-453f7779786962c86edd02466f02ba4a4acdf301.tar.gz
Telebot-453f7779786962c86edd02466f02ba4a4acdf301.tar.bz2
Telebot-453f7779786962c86edd02466f02ba4a4acdf301.tar.lz
Telebot-453f7779786962c86edd02466f02ba4a4acdf301.tar.xz
Telebot-453f7779786962c86edd02466f02ba4a4acdf301.tar.zst
Telebot-453f7779786962c86edd02466f02ba4a4acdf301.zip
Document implemented API methods
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2f33661..24e12dc 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,28 @@ One framework function provided by this library is `poll-updates` which enables
The common pattern of managing user specific conversations is supported via `make-conversation-manager`. This procedure instantiates a closure to be passed to e.g. `poll-updates` using a given token and _conversation handler_. All updates are then automatically distributed to an appropriate _conversation handler_ that may in turn be a closure maintaining conversation-specific state. `example/guess.scm` implements a practical bot based on this pattern.
+### Implemented API methods
+
+Based on the official [documentation](https://core.telegram.org/bots/api#available-methods).
+
+* getMe
+* getUpdates
+* sendMessage
+* forwardMessage
+* sendPhoto
+* sendAudio
+* sendDocument
+* sendSticker
+* sendVideo
+* sendVoice
+* sendLocation
+* sendChatAction
+* getUserProfilePhotos
+* getFile
+* answerInlineQuery
+
+The only missing method is `setWebhook` as this kind of interfacing with _Telegram_ is currently out of scope of this library. Should this be required an appropriate wrapper may be easily generated using the `wrap-api-method` macro described by the module.
+
## Build
git clone https://github.com/KnairdA/Telebot.git