Skip to content

Commit

Permalink
Add short repo overview to README
Browse files Browse the repository at this point in the history
  • Loading branch information
juntyr authored Aug 25, 2024
1 parent f9af139 commit 826cbf6
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
[![CI Status]][workflow] [![MSRV]][repo] [![Latest Version]][crates.io] [![Rust Doc Main]][docs]

[CI Status]: https://img.shields.io/github/actions/workflow/status/juntyr/numcodecs-rs/ci.yml?branch=main
[workflow]: https://github.com/juntyr/numcodecs-rs/actions/workflows/ci.yml?query=branch%3Amain

[MSRV]: https://img.shields.io/badge/MSRV-1.76.0-blue
[repo]: https://github.com/juntyr/numcodecs-rs

[Latest Version]: https://img.shields.io/crates/v/numcodecs
[crates.io]: https://crates.io/search?q=numcodecs

[Rust Doc Main]: https://img.shields.io/badge/docs-main-blue
[docs]: https://juntyr.github.io/numcodecs-rs
# numcodecs-rs

This repository provides a compression codec API in Rust inspired by the [`numcodecs`] Python API.

The repository is structured as follows:

- [`crates`](crates): Fundamental compression API crates
- [`numcodecs`](crates/numcodecs): Rusty compression codec API
- [`numcodecs-python`](crates/numcodecs-python): Rust bindings to the [`numcodecs`] Python API, which allows Python codecs to be used in Rust and Rust codecs to be used in Python
- [`numcodecs-wasm-guest`](crates/numcodecs-wasm-guest): Export a Rust codec as a WebAssembly [component] when compiling to WebAssembly
- [`codecs`](codecs): Codec implementation crates, some new, some adapting existing [`numcodecs`] codecs with a more composable API

[`numcodecs`]: https://numcodecs.readthedocs.io/en/stable/
[component]: https://component-model.bytecodealliance.org/design/components.html

## License

Licensed under the Mozilla Public License, Version 2.0 ([LICENSE](LICENSE) or https://www.mozilla.org/en-US/MPL/2.0/).
Expand Down

0 comments on commit 826cbf6

Please sign in to comment.