Release 0.1.0

mgeier · Nov 18, 2020 · b7d7283 · b7d7283
1 parent 67df1dd
commit b7d7283
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rtrb"
-version = "0.0.0"
+version = "0.1.0"
 authors = [
     "Stjepan Glavina <stjepang@gmail.com>",
     "Matthias Geier <Matthias.Geier@gmail.com>",

diff --git a/README.md b/README.md
@@ -1,7 +1,21 @@
 Real-Time Ring Buffer
 =====================
 
-Package on https://crates.io/ and documentation on https://docs.rs/ coming soon!
+A wait-free single-producer single-consumer ring buffer for Rust.
+
+* Crate: https://crates.io/crates/rtrb
+* Documentation: https://docs.rs/rtrb
+
+
+Usage
+-----
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+rtrb = "0.1"
+```
 
 
 Development