summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-07-17 16:40:41 +0300
committerYuval Adam <_@yuv.al>2022-07-17 16:40:41 +0300
commit992cdcb4ae5156efb61b754e6f0f3692314f1a8a (patch)
treebfaf409c0066a84cf53c3d334d7f157880dd75ce /README.md
parent2ab5e7531406d30224403a5837dcc9e8890f1640 (diff)
Update README usage
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index f059b02..27cc0b7 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,20 @@ Rust system bindings for the [codec2](https://github.com/drowe67/codec2) library
Automagically generated via [bindgen](https://github.com/rust-lang/rust-bindgen).
+## Usage
+
+Install with `cargo add`:
+
+```bash
+$ cargo add codec2-sys
+```
+
+Or add manually to your `Cargo.toml`:
+
+```
+codec2-sys = "1.0.0"
+```
+
## License
[LGPL-2.1](LICENSE) \ No newline at end of file