From a98b1bea816b7f56c70564e73cea5f40c5139c16 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Mon, 27 May 2019 10:40:46 +0300
Subject: Cleanup READMEs

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cdab8d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# bchlib
+
+![Crates.io](https://img.shields.io/crates/v/bchlib.svg)
+
+Rust bindings for BCH encoding/decoding library, based on the [bch_codec](https://github.com/mborgerding/bch_codec) fork.
+
+This workspace repo contains both the high-level `bchlib` project as well as the lower-level `bchlib-sys` project that builds the original C library.
+
+## Usage
+
+Add the library to your `Cargo.toml`:
+
+```
+[dependencies]
+bchlib = "0.1.0"
+```
+
+## Build
+
+The usual:
+
+```bash
+$ cargo build
+$ cargo test
+```
+
+Note that due to usage of `bindgen` in the lower level `bchlib-sys` project, you will need `clang` to be installed on your system.
+
+## License
+
+[GPLv2](LICENSE.md)
-- 
cgit v1.3.1