Skip to content

Commit

Permalink
Update the readme file and the version
Browse files Browse the repository at this point in the history
  • Loading branch information
enricostara committed Aug 11, 2015
1 parent c063d99 commit 89a3f01
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[![Sauce Test Status][sauce-image]][sauce-url]


**ALPHA SOFTWARE**

###_telegram.link_ is a Telegram API library for

- **Hybrid Mobile Apps** (phone and tablet)
Expand All @@ -12,6 +14,8 @@

- **Server-side Apps** (i.e. a Command-Line Interface)

- **Desktop Apps** (i.e. as third party module using the [NW.js](https://github.com/nwjs/nw.js) runtime)

**telegram.link** is an unofficial **porting in javascript** of the [Telegram Application Programming Interface](https://core.telegram.org/api).

**telegram.link** library enables to **write once** a **client-application** (whole or only the communication part) that
Expand All @@ -34,19 +38,19 @@ As soon as a new feature will be available in **telegram.link** it will be explo

- [User Autorization](https://core.telegram.org/api/auth): completed

- user-contact/update-message management, message exchange: ongoing
- user-contact/update-message management, message exchange: completed

_See the project status page on the [wiki](https://github.com/enricostara/telegram.link/wiki/Project-Status) for the last notes_
- Starts the [ALPHA](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) phase.

_See the project status page on the [wiki](https://github.com/enricostara/telegram.link/wiki/Project-Status) for the last notes._


## Documentation

The api documentation is generated under the _doc/_ folder, you can browse it here:
## Documentation

- [main module](https://rawgit.com/enricostara/telegram.link/master/doc/telegram.link.html)
The api documentation is generated under the _doc/_ folder.

- [auth module](https://rawgit.com/enricostara/telegram.link/master/doc/auth.html)
_See the documentation page on the [wiki](https://github.com/enricostara/telegram.link/wiki/Docs)._


## Project Architecture
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "telegram.link",
"version": "0.5.0",
"version": "0.6.0",
"description": "Telegram API library",
"keywords": [
"telegram",
Expand Down

0 comments on commit 89a3f01

Please sign in to comment.