From 82388514aa38f632738e60337712dc036fc3dbb8 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Mon, 18 Mar 2019 14:41:36 +0200
Subject: Add README and LICENSE

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c8d7b5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# bchlib
+
+![Crates.io](https://img.shields.io/crates/v/bchlib.svg)
+
+High-level Rust bindings for BCH encoding/decoding library, based on the [bch_codec](https://github.com/mborgerding/bch_codec) fork.
+
+The lower level library can be found at: https://github.com/yuvadm/bchlib-sys
+
+## Usage
+
+Add the library to your `Cargo.toml`:
+
+```
+[dependencies]
+bchlib = "0.1.0"
+```
+
+## Build
+
+The usual:
+
+```bash
+$ cargo build
+$ cargo test
+```
+
+## License
+
+[GPLv2](LICENSE.md)
-- 
cgit v1.3.1