summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 721e13b..a78c041 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,20 @@
# bchlib-sys
+![Crates.io](https://img.shields.io/crates/v/bchlib-sys.svg)
+
Low-level Rust bindings for BCH encoding/decoding library, based on the [bch_codec](https://github.com/mborgerding/bch_codec) fork.
+The higher level library can be found at: https://github.com/yuvadm/bchlib
+
+## Usage
+
+Add the library to your `Cargo.toml`:
+
+```
+[dependencies]
+bchlib-sys = "0.1.0"
+```
+
## Build
The usual: