mirror of
https://github.com/codex-storage/nim-leopard.git
synced 2025-01-31 05:05:14 +00:00
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
|
# nim-leopard
|
||
|
|
||
|
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
|
||
|
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
|
||
|
[![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](https://github.com/status-im/nim-leopard#stability)
|
||
|
|
||
|
Nim wrapper for [Leopard-RS](https://github.com/catid/leopard): a fast library for [Reed-Solomon](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon_error_correction) erasure correction coding.
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
TODO
|
||
|
|
||
|
## Versioning
|
||
|
|
||
|
nim-leopard generally follows the upstream master branch.
|
||
|
|
||
|
## Stability
|
||
|
|
||
|
The API provided by this package is currently marked as experimental. Until it is marked as stable, it may be subject to breaking changes across any version bump.
|
||
|
|
||
|
## License
|
||
|
|
||
|
### Wrapper License
|
||
|
|
||
|
nim-leopard is licensed and distributed under either of:
|
||
|
|
||
|
* Apache License, Version 2.0: [LICENSE-APACHEv2](LICENSE-APACHEv2) or https://opensource.org/licenses/Apache-2.0
|
||
|
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
|
||
|
|
||
|
at your option. The contents of this repository may not be copied, modified, or distributed except according to those terms.
|
||
|
|
||
|
### Dependency License
|
||
|
|
||
|
Leopard-RS is [licensed](https://github.com/catid/leopard/blob/master/License.md) under the BSD 3-Clause License. See [their licensing page](https://github.com/catid/leopard/blob/master/License.md) for further information.
|