Skip to content

Commit

Permalink
update docs with refs to the new module
Browse files Browse the repository at this point in the history
  • Loading branch information
umputun committed Oct 28, 2024
1 parent 129367a commit de5d7a3
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
> # Usage
> If you want to use this fork in the project that imports the original repo, the easiest way is to:
> - `git submodule add [email protected]: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)
[![Go Reference](https://pkg.go.dev/badge/github.com/OvyFlash/telegram-bot-api/v6.svg)](https://pkg.go.dev/github.com/OvyFlash/telegram-bot-api/v6)
[![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](https://pkg.go.dev/github.com/go-telegram-bot-api/telegram-bot-api/v5) page should
All methods are fairly self-explanatory, and reading the [godoc](https://pkg.go.dev/github.com/OvyFlash/telegram-bot-api/v6) page should
explain everything. If something isn't clear, open an issue or submit
a pull request.

Expand All @@ -27,7 +19,7 @@ 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/v5`.
`go get -u github.com/OvyFlash/telegram-bot-api/v6`.

This is a very simple bot that just displays any gotten updates,
then replies it to that chat.
Expand All @@ -38,7 +30,7 @@ package main
import (
"log"

tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5"
tgbotapi "github.com/OvyFlash/telegram-bot-api/v6"
)

func main() {
Expand Down Expand Up @@ -79,7 +71,7 @@ import (
"log"
"net/http"

"github.com/go-telegram-bot-api/telegram-bot-api/v5"
"github.com/OvyFlash/telegram-bot-api/v6"
)

func main() {
Expand Down

0 comments on commit de5d7a3

Please sign in to comment.