Update docs.
Syfaro syfaro@huefox.com
Mon, 08 Nov 2021 14:47:43 -0500
3 files changed,
7 insertions(+),
10 deletions(-)
M
README.md
→
README.md
@@ -1,7 +1,7 @@
# Golang bindings for the Telegram Bot API -[![GoDoc](https://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api?status.svg)](http://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api) -[![Travis](https://travis-ci.org/go-telegram-bot-api/telegram-bot-api.svg)](https://travis-ci.org/go-telegram-bot-api/telegram-bot-api) +[![Go Reference](https://pkg.go.dev/badge/github.com/go-telegram-bot-api/telegram-bot-api/v5.svg)](https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api/v5) +[![Test](https://github.com/go-telegram-bot-api/telegram-bot-api/actions/workflows/test.yml/badge.svg)](https://github.com/go-telegram-bot-api/telegram-bot-api/actions/workflows/test.yml) All methods are fairly self explanatory, and reading the [godoc](http://godoc.org/github.com/go-telegram-bot-api/telegram-bot-api) page should explain everything. If something isn't clear, open an issue or submit@@ -18,7 +18,7 @@
## Example First, ensure the library is installed and up to date by running -`go get -u github.com/go-telegram-bot-api/telegram-bot-api`. +`go get -u github.com/go-telegram-bot-api/telegram-bot-api/v5`. This is a very simple bot that just displays any gotten updates, then replies it to that chat.@@ -29,7 +29,7 @@
import ( "log" - "github.com/go-telegram-bot-api/telegram-bot-api" + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" ) func main() {@@ -62,7 +62,7 @@ }
} ``` -There are more examples on the [site](https://go-telegram-bot-api.github.io/) +There are more examples on the [site](https://go-telegram-bot-api.dev/) with detailed information on how to do many different kinds of things. It's a great place to get started on using keyboards, commands, or other kinds of reply markup.
M
docs/getting-started/README.md
→
docs/getting-started/README.md
@@ -10,11 +10,8 @@
## Installing ```bash -go get -u github.com/go-telegram-bot-api/telegram-bot-api/v5@develop +go get -u github.com/go-telegram-bot-api/telegram-bot-api/v5 ``` - -It's currently suggested to use the develop branch. While there may be breaking -changes, it has a number of features not yet available on master. ## A Simple Bot