From c92d7d9c3911141b0c7d76323e6d0fc5c28e4338 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Mon, 18 Jul 2022 08:17:38 +0300
Subject: Update README for workspace

---
 README.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 27cc0b7..55c25ef 100644
--- a/README.md
+++ b/README.md
@@ -2,22 +2,26 @@
 
 Rust system bindings for the [codec2](https://github.com/drowe67/codec2) library.
 
-Automagically generated via [bindgen](https://github.com/rust-lang/rust-bindgen).
+Provides the following packages:
+  - `libcodec2`: ergonomic high-level bindings
+  - `codec2-sys`: low-level unsafe bindings, automagically generated via [bindgen](https://github.com/rust-lang/rust-bindgen).
+
+Unrelated to the [`codec2`](https://github.com/scriptjunkie/codec2) crate which is a partial pure-rust implementation.
 
 ## Usage
 
 Install with `cargo add`:
 
 ```bash
-$ cargo add codec2-sys
+$ cargo add libcodec2
 ```
 
 Or add manually to your `Cargo.toml`:
 
 ```
-codec2-sys = "1.0.0"
+libcodec2 = "1.0.0"
 ```
 
 ## License
 
-[LGPL-2.1](LICENSE)
\ No newline at end of file
+[LGPL-2.1](LICENSE)
-- 
cgit v1.3.1