astra
/
telegram-bot-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs.

bot-api-6.1
Syfaro 2021-11-08 14:47:43 -05:00
parent 6b71d4dd94
commit 2a2f7c5083
3 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,7 +1,7 @@
# Golang bindings for the Telegram Bot API # 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) [![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)
[![Travis](https://travis-ci.org/go-telegram-bot-api/telegram-bot-api.svg)](https://travis-ci.org/go-telegram-bot-api/telegram-bot-api) [![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 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 explain everything. If something isn't clear, open an issue or submit
@ -18,7 +18,7 @@ you want to ask questions or discuss development.
## Example ## Example
First, ensure the library is installed and up to date by running 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, This is a very simple bot that just displays any gotten updates,
then replies it to that chat. then replies it to that chat.
@ -29,7 +29,7 @@ package main
import ( import (
"log" "log"
"github.com/go-telegram-bot-api/telegram-bot-api" tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5"
) )
func main() { func main() {
@ -62,7 +62,7 @@ func main() {
} }
``` ```
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. 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 It's a great place to get started on using keyboards, commands, or other
kinds of reply markup. kinds of reply markup.

5
docs/getting-started/README.md
View File

@ -10,12 +10,9 @@ approaches to solve common problems.
## Installing ## Installing
```bash ```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 ## A Simple Bot
To walk through the basics, let's create a simple echo bot that replies to your To walk through the basics, let's create a simple echo bot that replies to your

2
go.mod
View File

@ -1,3 +1,3 @@
module github.com/go-telegram-bot-api/telegram-bot-api/v5 module github.com/go-telegram-bot-api/telegram-bot-api/v5
go 1.13 go 1.16