Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit c6d06cc

Browse files
committed
Updated documentation
1 parent b16b46e commit c6d06cc

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,26 @@
44
[![Code Coverage](https://scrutinizer-ci.com/g/unreal4u/telegram-api/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/unreal4u/telegram-api/?branch=master)
55
[![License](https://poser.pugx.org/unreal4u/telegram-api/license)](https://packagist.org/packages/unreal4u/telegram-api)
66

7-
Telegram Log
7+
Telegram API
88
======
99

10-
Enables sending messages, photos, videos and many other things to Telegram from PHP via the open-source Telegram API.
11-
I hope I'll be able to build a complete implementation soon. For now it remains a bit of work in progress.
10+
This is a complete PHP7 bot API implementation for Telegram.
1211

1312
About this class
1413
--------
1514

1615
* Enables you to send messages, stickers, location and other methods via PHP to Telegram.
1716
* Respects and implements the default types and methods made by Telegram itself.
18-
* Doesn't need any dependency: you are free to do whatever you want with the available data.
17+
* Doesn't need any dependency, except for Guzzle. I'm working on an implementation that doesn't require Guzzle as well.
18+
* Inline bots support!
1919

2020
Detailed description
2121
---------
2222

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

2728
Why PHP7 only?
2829
----------
@@ -67,7 +68,7 @@ Please refer to the examples directory to view examples of all implemented metho
6768
Getting updates via Webhook
6869
---------
6970

70-
The first you'll have to do is register a webhook with Telegram via the SetWebhook method:
71+
The first thing you'll have to do is register a webhook with Telegram via the SetWebhook method:
7172

7273
<pre>
7374
$setWebhook = new SetWebhook();
@@ -86,7 +87,8 @@ $update = new Update($_POST);
8687
Now <code>$update</code> will contain the actual Update object. Hope that wasn't too difficult :)
8788

8889
More information on this? You can check [how I implemented](https://github.com/unreal4u/tg-timebot) my
89-
[timeBot](https://telegram.me/TheTimeBot).
90+
[timeBot](https://telegram.me/TheTimeBot). Take however into account that the cited repo is only a playground (for now),
91+
so it can happen that things in that repository may or may not work as expected.
9092

9193
Inline bots
9294
----------

0 commit comments

Comments
 (0)