clarify scope of project in readme, update godoc link

bot-api-6.1
Syfaro 2015-06-29 22:55:58 -05:00
parent 2024a55b87
commit b68832daa6
1 changed files with 5 additions and 1 deletions

View File

@ -1,10 +1,14 @@
# Golang Telegram bindings for the Bot API
[![GoDoc](https://godoc.org/src.foxpaw.in/Syfaro/telegram-bot-api?status.svg)](https://godoc.org/src.foxpaw.in/Syfaro/telegram-bot-api)
[![GoDoc](https://godoc.org/github.com/Syfaro/telegram-bot-api?status.svg)](http://godoc.org/github.com/Syfaro/telegram-bot-api)
All methods have been added, and all features should be available.
If you want a feature that hasn't been added yet or something is broken, open an issue and I'll see what I can do.
All methods are fairly self explanatory, and reading the godoc page should explain everything. If something isn't clear, open an issue or submit a pull request.
The scope of this project is just to provide a wrapper around the API without any additional features. There are other projects (including one I am developing myself) for creating something with plugins and command handlers without having to design all that yourself.
## Example
This is a very simple bot that just displays any gotten updates, then replies it to that chat.