<commit_before>
# <img src="./telegram.link.png" width="40"/> telegram.link 
[![npm version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coverage-image]][coverage-url] [![Climate Status][climate-image]][climate-url] [![Dependency Status][gemnasium-image]][gemnasium-url]
[![Sauce Test Status][sauce-image]][sauce-url]


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

- **Hybrid Mobile Apps** (phone and tablet)

- **Desktop Web Apps** (standard HTML5 browsers)

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

**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
runs both on **mobile and desktop browsers** and also on a **Node.js server**  and connect to the **Telegram data-centers**
via standard [protocol](https://core.telegram.org/mtproto) and API.


## Telegram.link in action! 

To start with the **telegram.link** library, you can install and study the [Termgram](http://termgram.me) application.
**Termgram** is a terminal client to connect with Telegram and uses all the features currently available in **telegram.link**.
The source code is quite straightforward and you'll be able to take inspiration to build your own application!
As soon as a new feature will be available in **telegram.link** it will be exploited by **Termgram**. 


## Project Status

- [Creating an Authorization Key](https://core.telegram.org/mtproto/auth_key): completed

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

- Contact and update management, message exchange : ongoing


## Documentation

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

- [main module](https://rawgit.com/enricostara/telegram.link/master/doc/telegram.link.html)

- [auth module](https://rawgit.com/enricostara/telegram.link/master/doc/auth.html)


## Project Architecture

The whole library is split in **three projects**:
  
- **telegram.link** (this library): is the main project and provides the **highest-level interface** to communicate with the Telegram data-center. 
When you write your **_'telegram-like-app'_** you should deal only with this module.<commit_msg>Update the realm<commit_after>
# <img src="./telegram.link.png" width="40"/> telegram.link 
[![npm version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coverage-image]][coverage-url] [![Climate Status][climate-image]][climate-url] [![Dependency Status][gemnasium-image]][gemnasium-url]
[![Sauce Test Status][sauce-image]][sauce-url]


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

- **Hybrid Mobile Apps** (phone and tablet)

- **Desktop Web Apps** (standard HTML5 browsers)

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

**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
runs both on **mobile and desktop browsers** and also on a **Node.js server**  and connect to the **Telegram data-centers**
via standard [protocol](https://core.telegram.org/mtproto) and API.


## Telegram.link in action! 

To start with the **telegram.link** library, you can install and study the [Termgram](http://termgram.me) application.
**Termgram** is a terminal client to connect with Telegram and uses all the features currently available in **telegram.link**.
The source code is quite straightforward and you'll be able to take inspiration to build your own application!
As soon as a new feature will be available in **telegram.link** it will be exploited by **Termgram**. 


## Project Status


- [Creating an Authorization Key](https://core.telegram.org/mtproto/auth_key): completed

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

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

_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:

- [main module](https://rawgit.com/enricostara/telegram.link/master/doc/telegram.link.html)

- [auth module](https://rawgit.com/enricostara/telegram.link/master/doc/auth.html)


## Project Architecture

The whole library is split in **three projects**:
  
- **telegram.link** (this library): is the main project and provides the **highest-level interface** to communicate with the Telegram data-center. 
When you write your **_'telegram-like-app'_** you should deal only with this module.
{'fraction_non_alphanumeric': 0.1332922571369891, 'fraction_numerical': 0.0012322858903265558, 'mean_word_length': 5.034696406443619, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 13, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4566947', 'n_tokens_mistral': 1476, 'n_tokens_neox': 1411, 'n_words': 493}