From 01d92dba1d8bc4ba44fd8995f2699e7d66d543c7 Mon Sep 17 00:00:00 2001 From: Yago Date: Mon, 12 Jan 2015 21:17:16 +0100 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++-------------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 077b642..4820f56 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,25 @@ Multimedia - 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/zW7WWWt.png](http://i.imgur.com/kPK7paz.png) -Command list + +Default enabled commands ------------ ``` !9gag -> send random image from 9gag !echo [whatever] -> echoes the msg -!eur [USD] -> EURUSD market value -!uc3m -> Fortunes from Universidad Carlos III !get (value_name) -> retrieves variables saved with !set -say hello to [name] -> Says hello to someone -!help -> Lists all available commands -!img [topic] -> search image with Google API and sends it -!ping -> bot sends pong -!rae [word] -> Spanish dictionary !set [value_name] [data] -> Set value +!img [topic] -> search image with Google API and sends it +!loc (location) -> Gets information about a location, maplink and overview !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) +!google terms -> Searches Google +!help -> Lists all available commands ``` 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 unzip git @@ -52,12 +47,28 @@ $ sudo luarocks install luasocket $ cd $HOME $ git clone https://github.com/yagop/telegram-bot.git --recursive $ cd telegram-bot/tg -$ ./configure && make -$ cd .. +$ ./configure && make && cd .. +$ ./launch.sh # Will ask you for a phone number & confirmation code. +``` + +Enable more [`plugins`](https://github.com/yagop/telegram-bot/tree/master/plugins) +------------- +See the plugins list with `!plugins` command. + +Enable with `!plugins enable [name]`. + +Disable with `!plugins disable [plugin]`. + +Those commands require a privileged user, privileged users are defined inside `data/config.lua` (generated by the bot), stop de bot and edit if necessary. + + +Run it as a daemon +------------ +If your linux/unix comes with [upstart](http://upstart.ubuntu.com/) you can run the bot by this way +```bash $ sed -i "s/yourusername/$(whoami)/g" etc/telegram.conf $ sed -i "s_telegrambotpath_$(pwd)_g" etc/telegram.conf $ sudo cp etc/telegram.conf /etc/init/ -$ ./launch.sh # Will ask you for a phone number & confirmation code. ``` Contact me