clarify scope of project in readme, update godoc link
Syfaro syfaro@foxpaw.in
Mon, 29 Jun 2015 22:55:58 -0500
1 files changed,
5 insertions(+),
1 deletions(-)
jump to
M
README.md
→
README.md
@@ -1,9 +1,13 @@
# Golang Telegram bindings for the Bot API -[](https://godoc.org/src.foxpaw.in/Syfaro/telegram-bot-api) +[](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