summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-07-30 17:44:39 +0300
committerYuval Adam <_@yuv.al>2022-07-30 17:44:39 +0300
commitec4708fe19d27dc097cbeca0f40a90a65abd4e99 (patch)
tree04aec13ecbba75744bc2dee22d76008ba1a83ba0
parentbb2356dae10db7a9d1e0a1171c81ddb5b6284d96 (diff)
Update README
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 322a6dd..c1d486a 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,12 @@
Rust system bindings for the [codec2](https://github.com/drowe67/codec2) library.
Provides the following packages:
- - [`libcodec2`](libcodec2): ergonomic high-level bindings
- - [`codec2-sys`](codec2-sys): low-level unsafe bindings, automagically generated via [bindgen](https://github.com/rust-lang/rust-bindgen).
+ - [`libcodec2`](libcodec2): safe and ergonomic wrappers around the core libcodec2 function calls
+ - [`codec2-sys`](codec2-sys): unsafe low-level 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.
+Additionally, this repo includes [`c2enc`](c2enc) which is a demo CLI program that imitates the original `c2enc`.
+
+This project is unrelated to the [`codec2`](https://github.com/scriptjunkie/codec2) crate which is a partial pure-rust implementation.
## Usage