diff --git a/README.md b/README.md index d04e586..2addf5d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -FILE BOT - Share files with friends and family using [Tox](https://tox.chat/) +###File bot +A bot which allows you to easily share files with friends and family using [Tox](https://tox.chat/) + +Based on [toxygen](https://github.com/xveduk/toxygen/) toxcore wrapper # Supported OS: @@ -26,19 +29,34 @@ FILE BOT - Share files with friends and family using [Tox](https://tox.chat/) ``python main.py path_to_profile`` #Commands: -``help - list of commands +help - list of commands + rights - get access rights + files - show list of files (get access) + stats - downloads statistics (get access) + id - get bot's id (get access) + share - send file to friend (get access) + share --all - send file to all friends (get access) + size - get size of file (get access) + get - get file with specified filename (get access) + del - remove file with specified filename (delete access) + rename --new - rename file (delete access) + user - new rights (example: rwdm) for user (masters only) + status - new status message (masters only) + name - new name (masters only) + message - send message to friend (masters only) - message --all - send message to all friends (masters only)`` \ No newline at end of file + + message --all - send message to all friends (masters only)