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 +++++++++++++++++++++++++++++++
 bchlib-sys/README.md | 31 -------------------------------
 bchlib/README.md     | 29 -----------------------------
 3 files changed, 31 insertions(+), 60 deletions(-)
 create mode 100644 README.md
 delete mode 100644 bchlib-sys/README.md
 delete mode 100644 bchlib/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)
diff --git a/bchlib-sys/README.md b/bchlib-sys/README.md
deleted file mode 100644
index 1325e75..0000000
--- a/bchlib-sys/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# 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:
-
-```bash
-$ cargo build
-$ cargo test
-```
-
-Note that due to usage of `bindgen` you will need `clang` to be installed on your system.
-
-## License
-
-[GPLv2](LICENSE.md)
diff --git a/bchlib/README.md b/bchlib/README.md
deleted file mode 100644
index 9c8d7b5..0000000
--- a/bchlib/README.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# 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