frostfs-api/README.md
Vitaliy Potyarkin 4c51a9b9d6 [#71] Stop using obsolete .github directory
This commit is a part of multi-repo cleanup effort:
TrueCloudLab/frostfs-infra#136

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
2024-11-06 15:10:17 +03:00

36 lines
1 KiB
Markdown

<p align="center">
<img src="./.forgejo/logo.svg" width="500px" alt="FrostFS">
</p>
<p align="center">
<a href="https://frostfs.info">FrostFS</a> API language-agnostic protocol definitions
</p>
---
![Release](https://git.frostfs.info/TrueCloudLab/frostfs-api/badges/release.svg)
## Overview
FrostFS-API repository is the basis for language-specific libraries, e.g.:
- [frostfs-api-go](https://git.frostfs.info/TrueCloudLab/frostfs-api-go)
Those libraries contain compiled protocol buffers definitions, wrapped with
language-specific code. Use them to integrate applications with FrostFS.
This repository contains:
- protocol buffers packages
- [auto-generated docs](proto-docs) for protocol buffers
## Contributing
Feel free to contribute to this project after reading the [contributing
guidelines](CONTRIBUTING.md).
Before you start working on a certain topic, first create a new issue
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