<p align="center">
<img src="./.github/logo.svg" width="500px" alt="FrostFS">
</p>
<p align="center">
  <a href="https://objectstorage.info">FrostFS</a> API language-agnostic protocol definitions
</p>

---
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/TrueCloudLab/frostfs-api?sort=semver)
![License](https://img.shields.io/github/license/TrueCloudLab/frostfs-api.svg?style=popout)

## Overview

FrostFS-API repository is the basis for language-specific libraries, e.g.:

- [frostfs-api-go](https://github.com/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