From 16cfbb611c3d987495eafb4eee7b7def579c06e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannes=20H=C3=B6ke?= Date: Tue, 8 Mar 2016 02:11:38 +0100 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4de50ae..ababf32 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ -# mau_mau_bot -Telegram Bot that allows you to play Mau Mau (UNO) via inline queries +# UNO Bot +Telegram Bot that allows you to play the popular card game UNO via inline queries. The bot currently runs as [@mau_mau_bot](http://telegram.me/mau_mau_bot) + +To run the bot yourself, you will need: +- Python (tested with 3.4) +- The [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) module (tested with 3.3.0) + +Get a bot token from [@BotFather](http://telegram.me/BotFather), place it in `credentials.py` and run the bot with `python3 bot.py` + +Code documentation will be added soon™