summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md
diff options
context:
space:
mode:
authorWim <wim@42.be>2021-12-12 00:35:32 +0100
committerGitHub <noreply@github.com>2021-12-12 00:35:32 +0100
commit02e3d7852bf37cc2dd65aa9d37fc3501e17203f8 (patch)
treefb15a500adadafa78dc90449af30109d1b77f925 /vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md
parent3893a035be347a7687a41d2054dd1b274d3a0504 (diff)
downloadmatterbridge-msglm-02e3d7852bf37cc2dd65aa9d37fc3501e17203f8.tar.gz
matterbridge-msglm-02e3d7852bf37cc2dd65aa9d37fc3501e17203f8.tar.bz2
matterbridge-msglm-02e3d7852bf37cc2dd65aa9d37fc3501e17203f8.zip
Update telegram-bot-api to v5 (#1660)
Diffstat (limited to 'vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md')
-rw-r--r--vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md121
1 files changed, 0 insertions, 121 deletions
diff --git a/vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md b/vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md
deleted file mode 100644
index 43b33ed8..00000000
--- a/vendor/github.com/go-telegram-bot-api/telegram-bot-api/README.md
+++ /dev/null
@@ -1,121 +0,0 @@
-# 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)
-
-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
-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 for creating
-something with plugins and command handlers without having to design
-all that yourself.
-
-Join [the development group](https://telegram.me/go_telegram_bot_api) if
-you want to ask questions or discuss development.
-
-## 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`.
-
-This is a very simple bot that just displays any gotten updates,
-then replies it to that chat.
-
-```go
-package main
-
-import (
- "log"
-
- "github.com/go-telegram-bot-api/telegram-bot-api"
-)
-
-func main() {
- bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
- if err != nil {
- log.Panic(err)
- }
-
- bot.Debug = true
-
- log.Printf("Authorized on account %s", bot.Self.UserName)
-
- u := tgbotapi.NewUpdate(0)
- u.Timeout = 60
-
- updates, err := bot.GetUpdatesChan(u)
-
- for update := range updates {
- if update.Message == nil { // ignore any non-Message Updates
- continue
- }
-
- log.Printf("[%s] %s", update.Message.From.UserName, update.Message.Text)
-
- msg := tgbotapi.NewMessage(update.Message.Chat.ID, update.Message.Text)
- msg.ReplyToMessageID = update.Message.MessageID
-
- bot.Send(msg)
- }
-}
-```
-
-There are more examples on the [wiki](https://github.com/go-telegram-bot-api/telegram-bot-api/wiki)
-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.
-
-If you need to use webhooks (if you wish to run on Google App Engine),
-you may use a slightly different method.
-
-```go
-package main
-
-import (
- "log"
- "net/http"
-
- "github.com/go-telegram-bot-api/telegram-bot-api"
-)
-
-func main() {
- bot, err := tgbotapi.NewBotAPI("MyAwesomeBotToken")
- if err != nil {
- log.Fatal(err)
- }
-
- bot.Debug = true
-
- log.Printf("Authorized on account %s", bot.Self.UserName)
-
- _, err = bot.SetWebhook(tgbotapi.NewWebhookWithCert("https://www.google.com:8443/"+bot.Token, "cert.pem"))
- if err != nil {
- log.Fatal(err)
- }
- info, err := bot.GetWebhookInfo()
- if err != nil {
- log.Fatal(err)
- }
- if info.LastErrorDate != 0 {
- log.Printf("Telegram callback failed: %s", info.LastErrorMessage)
- }
- updates := bot.ListenForWebhook("/" + bot.Token)
- go http.ListenAndServeTLS("0.0.0.0:8443", "cert.pem", "key.pem", nil)
-
- for update := range updates {
- log.Printf("%+v\n", update)
- }
-}
-```
-
-If you need, you may generate a self signed certficate, as this requires
-HTTPS / TLS. The above example tells Telegram that this is your
-certificate and that it should be trusted, even though it is not
-properly signed.
-
- openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 3560 -subj "//O=Org\CN=Test" -nodes
-
-Now that [Let's Encrypt](https://letsencrypt.org) is available,
-you may wish to generate your free TLS certificate there.