all repos — telegram-bot-api @ 5198d8b69e2b5eddd09e44f320be9f05ce544ebd

Golang bindings for the Telegram Bot API

Update README.md
Valeriy Selitskiy 239034+iamwavecut@users.noreply.github.com
Mon, 15 Jan 2024 11:29:03 +0100
commit

5198d8b69e2b5eddd09e44f320be9f05ce544ebd

parent

63e5c59035bfde1a7babea214eceb0e2e60e816f

1 files changed, 8 insertions(+), 1 deletions(-)

jump to
M README.md → README.md 
@@ -1,5 +1,12 @@
-# Golang bindings for the Telegram Bot API
+> # Usage
+> If you want to use this fork in the project that imports the original repo, the easiest way is to:
+> - `git submodule add git@github.com:OvyFlash/telegram-bot-api.git telegram-bot-api`
+> - `go mod edit --replace github.com/go-telegram-bot-api/telegram-bot-api/v5=./telegram-bot-api/`
+> - `go mod tidy`
+> And you're ready to go.
+> Notice, that there have been several breaking changes since the telegram bot API v5 was released, so you might need to update your application.
 
+# Golang bindings for the 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)