diff --git a/README.md b/README.md index 8676106..48a11ff 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,6 @@ telegram-bot A telegram bot using https://github.com/vysheng/tg. -Installation ------------- -```bash -$ wget http://luarocks.org/releases/luarocks-2.2.0.tar.gz -$ tar -xzvf luarocks-2.2.0.tar.gz -$ cd luarocks-2.2.0/ -$ ./configure -$ make && sudo make install -$ sudo luarocks install oauth # You need unzip -``` - -```bash -# Tested on Ubuntu 14.04, for other OSs check out https://github.com/vysheng/tg#installation -$ sudo apt-get install lua-socket libreadline-dev libconfig-dev libssl-dev lua5.2 liblua5.2-dev libevent-dev -$ git clone git@github.com:yagop/telegram-bot.git --recursive -$ cd telegram-bot/tg -$ ./configure && make -$ cd .. && ./launch.sh # Will ask you for a phone number & confirmation code. -``` - Multimedia ---------- - When user sends image (png, jpg, jpeg) URL download and send it to origin. @@ -30,7 +10,7 @@ Multimedia - When user sends twitter URL, send text and images to origin. Requieres OAuth Key. - When user sends youtube URL, send to origin video image. -![http://i.imgur.com/0FGUvU0.png](http://i.imgur.com/0FGUvU0.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/zW7WWWt.png) +![http://i.imgur.com/0FGUvU0.png](http://i.imgur.com/0FGUvU0.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/zW7WWWt.png) ![http://i.imgur.com/zW7WWWt.png](http://i.imgur.com/kPK7paz.png) Command list ------------ ``` @@ -45,9 +25,33 @@ say hello to [name] -> Says hello to someone !ping -> bot sends pong !rae [word] -> Spanish dictionary !set [value_name] [data] -> Set value +!stats -> Numer of messages by user !time [area] -> Displays the local time in an area !tw [text] -> Sends a tweet !version -> Shows bot version !weather (city) -> weather in that city (Madrid is default) ``` +Installation +------------ + +```bash +# Tested on Ubuntu 14.04, for other OSs check out https://github.com/vysheng/tg#installation +$ sudo apt-get install libreadline-dev libconfig-dev libssl-dev lua5.2 liblua5.2-dev libevent-dev +$ cd /tmp +$ wget http://luarocks.org/releases/luarocks-2.2.0.tar.gz +$ tar -xzvf luarocks-2.2.0.tar.gz +$ cd luarocks-2.2.0/ +$ ./configure +$ make && sudo make install +$ sudo luarocks install oauth +$ sudo luarocks install luasocket +``` +```bash +# After those dependencies, lets install the bot +$ cd $HOME +$ git clone git@github.com:yagop/telegram-bot.git --recursive +$ cd telegram-bot/tg +$ ./configure && make +$ cd .. && ./launch.sh # Will ask you for a phone number & confirmation code. +``` \ No newline at end of file