frostfs-api-go/README.md

42 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

<p align="center">
<img src="./.github/logo.svg" width="500px" alt="NeoFS">
</p>
<p align="center">
Golang SDK for <a href="https://fs.neo.org">NeoFS</a>
</p>
2019-11-18 13:34:06 +00:00
---
![Tests](https://github.com/nspcc-dev/neofs-api-go/workflows/neofs-api-go%20tests/badge.svg)
2020-03-31 07:05:26 +00:00
[![codecov](https://codecov.io/gh/nspcc-dev/neofs-api-go/branch/master/graph/badge.svg)](https://codecov.io/gh/nspcc-dev/neofs-api-go)
[![Report](https://goreportcard.com/badge/github.com/nspcc-dev/neofs-api-go)](https://goreportcard.com/report/github.com/nspcc-dev/neofs-api-go)
[![GitHub release](https://img.shields.io/github/release/nspcc-dev/neofs-api-go.svg)](https://github.com/nspcc-dev/neofs-api-go)
![GitHub license](https://img.shields.io/github/license/nspcc-dev/neofs-api-go.svg?style=popout)
2020-02-05 10:55:07 +00:00
# Overview
2019-11-18 13:34:06 +00:00
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.
2019-11-18 13:34:06 +00:00
## NeoFS-API compatibility
|neofs-api-go version|supported NeoFS-API versions|
|:------------------:|:--------------------------:|
|< v1.20.0 **(unsupported)**|up to v1.2.0|
|v1.20.x|[v2.0.2](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.0.2)|
|v1.21.x|[v2.1.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.1.0)|
|v1.22.x|[v2.2.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.2.0)|
2019-11-18 13:34:06 +00:00
## Contributing
Feel free to contribute to this project after reading the [contributing
guidelines](CONTRIBUTING.md).
Before starting to work on a certain topic, create a new issue first, describing
the feature/topic you are going to implement.
2019-11-18 13:34:06 +00:00
## License
This project is licensed under the Apache 2.0 License -
2020-04-10 06:00:37 +00:00
see the [LICENSE](LICENSE) file for details