2020-09-04 06:45:46 +00:00
|
|
|
<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>
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
## Overview
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-04-01 15:04:37 +00:00
|
|
|
NeoFS-API repository is the basis for language-specific libraries, e.g.:
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-04-01 15:04:37 +00:00
|
|
|
- [neofs-api-go](https://github.com/nspcc-dev/neofs-api-go)
|
|
|
|
|
- [neofs-api-csharp](https://github.com/nspcc-dev/neofs-api-csharp)
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
Those libraries contain compiled protocol buffers definitions, wrapped with
|
|
|
|
|
language-specific code. Use them to integrate applications with NeoFS.
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-04-01 15:04:37 +00:00
|
|
|
This repository contains:
|
|
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
- protocol buffers packages
|
|
|
|
|
- [auto-generated docs](proto-docs) for protocol buffers
|
|
|
|
|
- [manually written docs](docs) for developers (to be done)
|
2020-04-01 15:04:37 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
# Contributing
|
2020-04-01 15:04:37 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
Feel free to contribute to this project after reading the [contributing
|
|
|
|
|
guidelines](CONTRIBUTING.md).
|
2020-04-01 15:04:37 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
Before starting to work on a certain topic, create an new issue first,
|
|
|
|
|
describing the feature/topic you are going to implement.
|
2020-01-30 11:41:24 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2020-04-10 06:25:00 +00:00
|
|
|
This project is licensed under the Apache 2.0 License -
|
|
|
|
|
see the [LICENSE](LICENSE) file for details
|
|
|
|
|
|
