1
0
mirror of https://github.com/fazo96/telecommander.git synced 2025-01-10 11:34:20 +01:00

update README

This commit is contained in:
Enrico Fasoli 2015-08-30 19:12:50 +00:00
parent bc5620df2a
commit 9107da1f37

View File

@ -1,10 +1,93 @@
# Telecommander # Telecommander
The experimental full-featured command line client for Telegram is in development. The experimental full-featured curses-like command line client for Telegram is in heavy development, but also already usable!
It uses [enricostara](http://github.com/enricostara)'s [telegram.link](http://github.com/enricostara/telegram.link) to connect to Telegram and [chjj](http://github.com/chjj)'s [blessed](http://github.com/chjj/blessed) for the UI. It uses [enricostara](http://github.com/enricostara)'s [telegram.link](http://github.com/enricostara/telegram.link) to connect to Telegram and [chjj](http://github.com/chjj)'s [blessed](http://github.com/chjj/blessed) for the UI.
At the moment you can use Telecommander to register or login into telegram. Yep, that's it for now, but stay tuned! ### What it can and can't do
As of __now__, __Telecommander lets you__:
- Sign up for telegram
- not sure it totally works, not really the priority for now
- Sign in with a code sent via SMS or telegram
- Keep signed in until you delete the files stored in `~/.config/telecommander` or the session expires
- Do everything __completely in the terminal, even via ssh__
- Navigate your contact and chat list __using the mouse__
- Do basic usage with __no complicated commands to learn__
- Chat with your friends!
- Chat in groups!
For version _0.1.0_ (Almost done!):
- Notifications
- Online Status viewing and management
- Automatic marking of messages as read
What's missing (for future versions up to 1.0)
- Scrolling back to view old messages
- Create, modify, manage groups
- Secret chats
- Manage your contacts
- Manage your profile
- Easy bot interaction
- Send and download files, audio messages, images
- Open links
- Emoticons (they show up as question marks)
- Sign out (without having to manually delete files)
- Delete account
- Reply to and Forward message support
- Do everything (except writing, duh) with the mouse!
- Cool interface (it's already ok, just not as cool as I want it to be)
- Optimization and automatic datacenter switching
What could be available after 1.0:
- plugin API
- Telecommander as a library
- Parsable output mode
- More cool stuff!
A lot of features depend on [telegram.link](http://telegram.link)'s still missing implementation sadly, but it'll come around eventually.
### Hacking
To start Telecommander from source you'll need:
- __npm__, most of the time packaged with node
- __python__ version 2.x (probably need a recent one)
- __git__ to download the source
Let's set it up:
```sh
$ git clone https://github.com/fazo96/Telecommander.git
$ cd Telecommander
# If you just need to test it
$ npm install
$ ./telecommander.js
# If you want to install it
# Try with sudo if it doesn't work
$ npm install -g .
$ telecommander
# If npm install fails because of something about "gyp"
# it means your python points to python 3
# either swap it with python 2 or if you're on arch linux
# and/or your python 2 executable is "python2" just run this:
$ PYTHON=python2 npm install [-g .]
```
__PLEASE READ:__ if you fork the project and want to create a custom version of
Telecommander please change the app.id and app.hash values in the source
(should be in the first 30 lines of code) to the ones you can get
(for free) from http://my.telegram.org
### License ### License