fazo96/telecommander
1
0
Fork 0
mirror of https://github.com/fazo96/telecommander.git synced 2025-01-26 14:04:18 +01:00
Code Issues Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Enrico Fasoli 2015-09-01 03:26:03 +02:00
parent 470a44e092
commit 53330ba4a7
1 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -9,38 +9,35 @@ It uses [enricostara](http://github.com/enricostara)'s [telegram.link](http://gi
As of __now__, __Telecommander lets you__: As of __now__, __Telecommander lets you__:
- Sign up for telegram - Sign up for telegram
- not sure it totally works, not really the priority for now - not sure it totally works, not really the priority for now! If it doesn't work and you need to sign up, use [Telegram Web](http://web.telegram.org)
- Sign in with a code sent via SMS or telegram - Sign in with a code sent via SMS or Telegram until you delete the Telecommander session files or the session expires
- Keep signed in until you delete the files stored in `~/.config/telecommander` or the session expires - Chat in groups and in private (it also marks messages as read when you read them)
- Do everything __completely in the terminal, even via ssh__ - Know when you have unread messages
- Navigate your contact and chat list __using the mouse__ - Do everything __completely in the terminal, even via ssh__ using only the keyboard
- Do basic usage with __no complicated commands to learn__ - Do everything (except writing, duh) using only the mouse!
- Chat with your friends! - Navigate your contact and chat list
- Chat in groups! - Scroll back to view old messages
For version _0.1.0_ (__Almost done!__): Waht's missing for version _0.1.0_ (__Almost done!__):
- Notifications - View who's online and when was the last time they logged in
- Online Status viewing and management - Testing and tying up loose ends in user interface and code quality
- Automatic marking of messages as read
What's missing (for future versions up to 1.0) What's missing (for future versions up to 1.0)
- Scrolling back to view old messages
- Create, modify, manage groups - Create, modify, manage groups
- Secret chats - Secret chats
- Manage your contacts - Manage your contacts
- Manage your profile - Manage your profile
- Easy bot interaction - Easy bot interaction
- Send and download files, audio messages, images - Send and view files, audio messages, images, videos, links
- Open links
- Emoticons (they show up as question marks) - Emoticons (they show up as question marks)
- Sign out (without having to manually delete files) - Sign out (without having to manually delete files)
- Delete account - Delete account
- Reply to and Forward message support - 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) - Cool interface (it's already ok, just not as cool as I want it to be)
- Search, Tab completion, command history - Search, Tab completion, chatbox history
- Send multiline messages
- Themes and configurability! Basic scripting! - Themes and configurability! Basic scripting!
- Optimization and automatic datacenter switching - Optimization and automatic datacenter switching
@ -51,7 +48,11 @@ What could be available after 1.0:
- Parsable output mode - Parsable output mode
- More cool stuff! - More cool stuff!
A lot of features depend on [telegram.link](http://telegram.link)'s still incomplete implementation sadly, but it'll come around eventually. Most of features depend on [telegram.link](http://telegram.link)'s still alpha-quality implementation sadly, but it'll come around eventually.
### Installing
This section shows how to install Telecommander. It will be populated when __0.1__ is done!
### Hacking ### Hacking
@ -64,6 +65,8 @@ To start Telecommander from source you'll need:
Let's set it up: Let's set it up:
```sh ```sh
# Download the source
$ git clone https://github.com/fazo96/Telecommander.git $ git clone https://github.com/fazo96/Telecommander.git
$ cd Telecommander $ cd Telecommander
@ -79,7 +82,7 @@ $ npm install -g .
$ telecommander $ telecommander
# If npm install fails because of something about "gyp" # If npm install fails because of something about "gyp"
# it means your python points to python 3 # it probably means your python points to python 3
# either swap it with python 2 or if you're on arch linux # either swap it with python 2 or if you're on arch linux
# and/or your python 2 executable is "python2" just run this: # and/or your python 2 executable is "python2" just run this: