Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
unreal4u committed Jan 8, 2017
1 parent 816dff7 commit 41a0481
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,19 @@ None at the moment. If you find any, feel free to [submit a PR](https://github.c

### About this class

* Enables you to send messages, stickers, location and other methods via PHP to a Telegram user (either direct conversation, channel or group).
* Enables you to anything supported by the Telegram Bot API: messages, stickers, location, inline bots and any other supported method via PHP to a Telegram user (either direct conversation, channel, group or supergroup).
* Respects and implements the default types and methods made by Telegram itself. Have any doubts about any method? [Just check the original documentation](https://core.telegram.org/bots/api), this implementation will not differ too much.
* Doesn't need any dependency, except for Guzzle, which you can inyect if you already use it elsewhere.
* **Full** inline bots support!

### Detailed description

This project was born to study the new concepts of PHP7 and to integrate some other knowledge I had previously heard
about but didn't have the time to play with them. The idea behind was to create a simple to use class which could
play nicely with the Telegram API. The end result however ended up being a complete bot API implementation.

## Installation

The preferred method is composer, so add the following to your composer.json:

```json
{
"require": {
"unreal4u/telegram-api": "~2.1"
"unreal4u/telegram-api": "~2.3"
}
}
```
Expand Down Expand Up @@ -67,7 +61,7 @@ Different methods return different object types.
Please refer to the [examples directory](https://github.com/unreal4u/telegram-api/tree/master/examples) to view examples
of some of the implemented methods, including inline bots.

For examples of actual code that works in a production environment, please refer to my other repo: https://github.com/unreal4u/tg-timebot
For examples of actual code that works in a production environment, please refer to my other repo: https://github.com/unreal4u/telegram-bots

### Getting updates via Webhook

Expand All @@ -76,7 +70,7 @@ more information on this.

### Inline bots

Please checkout the [special wiki page](https://github.com/unreal4u/telegram-api/wiki/Inline-Bots) about Inline bots.
Please checkout the [special wiki page](https://github.com/unreal4u/telegram-api/wiki/Inline-Bots) about inline bots.

### Extra requirements

Expand Down

0 comments on commit 41a0481

Please sign in to comment.