Fix changelog and add compatibility matrix in readme file

Signed-off-by: Alex Vanin <alexey@nspcc.ru>
This commit is contained in:
Alex Vanin 2020-11-17 09:52:50 +03:00 committed by Leonard Lyubich
parent 87a216dd96
commit dd19eb7eca
2 changed files with 15 additions and 3 deletions

View file

@ -1,8 +1,12 @@
# Changelog # Changelog
## [2.0.0] - 2020-11-16 - Jindo (진도, 珍島) ## [1.20.0] - 2020-11-16 - Jindo (진도, 珍島)
Major API refactoring and simplification. From now on this library will have
backward compatibility and support of major versions of NeoFS-API by having
**version specific** files in `vN` dirs and **version independent** SDK
structures and client in `pkg`. This version supports NeoFS-API v2.0.X
Major API refactoring and simplification.
### Added ### Added
- cross-protocol ```v2``` message types - cross-protocol ```v2``` message types
@ -396,4 +400,4 @@ Initial public release
[1.1.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.0.0...v1.1.0 [1.1.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.0.0...v1.1.0
[1.2.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.1.0...v1.2.0 [1.2.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.1.0...v1.2.0
[1.3.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.2.0...v1.3.0 [1.3.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.2.0...v1.3.0
[2.0.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.3.0...v2.0.0 [1.20.0]: https://github.com/nspcc-dev/neofs-api-go/compare/v1.3.0...v1.20.0

View file

@ -17,6 +17,14 @@
Go implementation of recent [NeoFS API](https://github.com/nspcc-dev/neofs-api) Go implementation of recent [NeoFS API](https://github.com/nspcc-dev/neofs-api)
versions and SDK layer working with all of them in a handy way. versions and SDK layer working with all of them in a handy way.
## NeoFS-API compatibility
|neofs-api-go version|supported NeoFS-API versions|
|:------------------:|:--------------------------:|
|< v1.20.0 **(unsupported)**|up to v1.2.0|
|v1.20.0|[v2.0.2](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.0.2)|
## Contributing ## Contributing
Feel free to contribute to this project after reading the [contributing Feel free to contribute to this project after reading the [contributing