Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
unreal4u committed Nov 3, 2016
1 parent 317e466 commit 410398a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
# Telegram API

This is a complete PHP7 bot API implementation for Telegram implementing the totality of Bot API version 2.1 (And up
until the vast mayority of October 2016)
until the vast mayority of October 2016, please check [the open issues](https://github.com/unreal4u/telegram-api/issues/12))

## Current status

The current version (v2.0.0) is currently almost ready, with some methods still to be implemented. These methods are:
The current version is stable enough to be used in production, with some methods still to be implemented. These missing
methods are:

- Parsing correctly answer we get from Telegram of certain inline responses.
- Some new methods related to games added on October 2016, [please check this link](https://core.telegram.org/bots/api/#recent-changes).
- Some new methods related to games added on October 2016, [please check this link](https://core.telegram.org/bots/api/#recent-changes) and [the following issue](https://github.com/unreal4u/telegram-api/issues/12).
- Ability to pass on an url as InputFile, there is barely any documentation on this subject.

If you are sure that you'll not use these capabilities, feel free to test it out, the basics should all be working
correctly at all times. If not, [let me know](https://github.com/unreal4u/telegram-api/issues)!
correctly at all times. If not, [let me know](https://github.com/unreal4u/telegram-api/issues) or send out a PR!

## About this class

Expand Down Expand Up @@ -170,7 +170,7 @@ either Laravel or MySQL:
* PHP-CS

I had heard of all these great tools previously but I didn't have a nice project to work on and learn properly. So this
project was born.
project was born.

At the same time, I wanted an API that did respect Telegram's API model as much as possible, while being friendly to a
developer as well. The result of that is this package, check the examples for usage.
Expand Down
2 changes: 1 addition & 1 deletion src/Telegram/Types/Custom/InputFile.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ private function setStream(): InputFile
if (is_readable($this->path)) {
$this->stream = fopen($this->path, 'r');
} else {
throw new FileNotReadable(sprintf('Can not read %s, please check', $this->path));
throw new FileNotReadable(sprintf('Can not read local file "%s", please check', $this->path));
}

return $this;
Expand Down

0 comments on commit 410398a

Please sign in to comment.