diff options
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a83c64 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Telebot + +... is a basic _Chicken Scheme_ module to ease the development of Bots interfacing with the [Telegram Bot API](https://core.telegram.org/bots/api). + +In this context _basic_ means that the module currently consists of barely more than raw HTTP API calls hidden behind analogously named functions and JSON deserialization provided by the _http-client_ respectively _medea_ eggs. + +The maintanance of these API wrappers is simplified by an appropriate _Scheme_ macro that reduces the implementation of new API methods to basically slightly rewriting the documentation. + +## Example + +`example/echo.scm` implements a bot that echoes all messages back to their sender. + +## Dependencies + +* [openssl](http://wiki.call-cc.org/eggref/4/openssl) +* [http-client](http://wiki.call-cc.org/eggref/4/http-client) +* [medea](http://wiki.call-cc.org/eggref/4/medea) +* [loops](http://wiki.call-cc.org/eggref/4/loops) +* [vector-lib](http://wiki.call-cc.org/eggref/4/vector-lib) |