From f8eab2708f229d3187a0329983df7536c7bc0e01 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Mon, 23 Jul 2018 20:26:33 +0300
Subject: Rename project

---
 README.md | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c63771b..621fa5a 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,30 @@
-# RusTL
+# RusTL-SDR
 
-A pure Rust implementation of the [RTL-SDR](https://github.com/osmocom/rtl-sdr/) driver.
+A pure Rust implementation of the [RTL-SDR](https://github.com/osmocom/rtl-sdr/) driver, for shits and giggles.
 
-This is mostly an exercise in writing low-level driver code and is unlikely to ever become seriously useful.
+This is mostly an exercise in writing low-level driver code.
+
+Unusable, and highly unlikely to ever become usable. But it's fun.
+
+## Usage
+
+Install the crate in your `Cargo.toml`:
+
+```toml
+[dependencies]
+rustl-sdr = "0.1"
+```
+
+Use in your code:
+
+```rust
+extern crate rustl_sdr;
+
+fn foo() {
+    rtlsdr = rustl_sdr::RtlSdr::new();
+    rtlsdr.do_stuff()
+}
+```
 
 ## Dev
 
-- 
cgit v1.3.1