From 1a1dd694aa26b560a64d5d23c082890587ea4562 Mon Sep 17 00:00:00 2001 From: Igor Zhukov Date: Thu, 24 Oct 2013 22:25:37 +0400 Subject: [PATCH] Update README.md Improved Readme --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f5dbf33..ddd85a0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ -telegram-client. Uses readline interface. +## Telegram messenger CLI + +Command-line interface for [Telegram](http://telegram.org). Uses readline interface. + +### API, Protocol documentation + +Documentation for Telegram API is available here: http://core.telegram.org/api +Documentation for MTproto protocol is available here: http://core.telegram.org/mtproto + +### Installation + +Just run `make` + +### Usage + + ./telegram -k + +By default public key is stored in the same folder named tg.pub: + + ./telegram -k tg.pub + +#### Supported commands: + +* chat_info +* contact_list +* dialog_list +* help +* history +* msg +* send_photo +* send_text +* send_video +* stats -usage: telegram -k