Skip to content

doc: add a note about unstable v3 to the README.md #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2025
Merged

doc: add a note about unstable v3 to the README.md #484

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecb2118
doc: fix links to v3 in the README.md
oleg-jukovec Oct 30, 2025
05429af
doc: add a note about unstable v3 to the README.md
oleg-jukovec Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@
[![GitHub Discussions][discussions-badge]][discussions-url]
[![Stack Overflow][stackoverflow-badge]][stackoverflow-url]

# ⚠️ Development Status Notice

**The current `main` branch is under active development for the next major
release (v3).**

The API on this branch is **unstable and subject to change**.

**For production use and stable API, please use the
[`v2`](https://github.com/tarantool/go-tarantool/tree/v2) branch of the
repository.**

# Client in Go for Tarantool

The package `go-tarantool` contains everything you need to connect to
Expand Down Expand Up @@ -46,7 +57,7 @@ The package `go-tarantool` is located in [tarantool/go-tarantool][go-tarantool]
repository. To download and install, say:

```
$ go get github.com/tarantool/go-tarantool/v2
$ go get github.com/tarantool/go-tarantool/v3
```

This should put the source and binary files in subdirectories of
Expand Down Expand Up @@ -131,7 +142,7 @@ func main() {
}
```

**Observation 1:** The line "`github.com/tarantool/go-tarantool/v2`" in the
**Observation 1:** The line "`github.com/tarantool/go-tarantool/v3`" in the
`import(...)` section brings in all Tarantool-related functions and structures.

**Observation 2:** Unused import lines are required to initialize encoders and
Expand Down Expand Up @@ -245,8 +256,8 @@ There are two other connectors available from the open source community:
See feature comparison in the [documentation][tarantool-doc-connectors-comparison].

[tarantool-site]: https://tarantool.io/
[godoc-badge]: https://pkg.go.dev/badge/github.com/tarantool/go-tarantool/v2.svg
[godoc-url]: https://pkg.go.dev/github.com/tarantool/go-tarantool/v2
[godoc-badge]: https://pkg.go.dev/badge/github.com/tarantool/go-tarantool/v3.svg
[godoc-url]: https://pkg.go.dev/github.com/tarantool/go-tarantool/v3
[actions-badge]: https://github.com/tarantool/go-tarantool/actions/workflows/testing.yml/badge.svg
[actions-url]: https://github.com/tarantool/go-tarantool/actions/workflows/testing.yml
[coverage-badge]: https://coveralls.io/repos/github/tarantool/go-tarantool/badge.svg?branch=master
Expand All @@ -261,5 +272,5 @@ See feature comparison in the [documentation][tarantool-doc-connectors-compariso
[go-tarantool]: https://github.com/tarantool/go-tarantool
[tarantool-doc-data-model-url]: https://www.tarantool.io/en/doc/latest/book/box/data_model/
[tarantool-doc-box-space-url]: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/
[godoc-opts-url]: https://pkg.go.dev/github.com/tarantool/go-tarantool/v2#Opts
[godoc-opts-url]: https://pkg.go.dev/github.com/tarantool/go-tarantool/v3#Opts
[tarantool-doc-connectors-comparison]: https://www.tarantool.io/en/doc/latest/book/connectors/#go-feature-comparison
Loading