From 89a3f0130500b733241734afc01541abd7e65d1f Mon Sep 17 00:00:00 2001 From: Enrico Stara Date: Wed, 12 Aug 2015 00:44:55 +0200 Subject: [PATCH] Update the readme file and the version --- README.md | 16 ++++++++++------ package.json | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f21485e..9333fae 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 @@ -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 diff --git a/package.json b/package.json index 739d08a..36b142a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "telegram.link", - "version": "0.5.0", + "version": "0.6.0", "description": "Telegram API library", "keywords": [ "telegram",