frostfs-api/README.md
Stanislav Bogatyrev 2f808917d1 Add README.md
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
2020-09-04 18:31:32 +03:00

41 lines
1.3 KiB
Markdown

<p align="center">
<img src="./.github/logo.svg" width="500px" alt="NeoFS">
</p>
<p align="center">
<a href="https://fs.neo.org">NeoFS</a> API language-agnostic protocol definitions
</p>
---
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neofs-api?sort=semver)
![License](https://img.shields.io/github/license/nspcc-dev/neofs-api.svg?style=popout)
## Overview
NeoFS-API repository is the basis for language-specific libraries, e.g.:
- [neofs-api-go](https://github.com/nspcc-dev/neofs-api-go)
- [neofs-api-csharp](https://github.com/nspcc-dev/neofs-api-csharp)
Those libraries contain compiled protocol buffers definitions, wrapped with
language-specific code. Use them to integrate applications with NeoFS.
This repository contains:
- protocol buffers packages
- [auto-generated docs](proto-docs) for protocol buffers
- [manually written docs](docs) for developers (to be done)
# Contributing
Feel free to contribute to this project after reading the [contributing
guidelines](CONTRIBUTING.md).
Before starting to work on a certain topic, create an new issue first,
describing the feature/topic you are going to implement.
## License
This project is licensed under the Apache 2.0 License -
see the [LICENSE](LICENSE) file for details