Documentation improvements.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "actix-cbor"
-version = "0.1.3"
+version = "0.1.4"
 authors = ["noah <[email protected]>"]
 edition = "2018"
 description = "CBOR support for Actix-Web"

README.md

@@ -3,6 +3,25 @@ This crate provides an extractor for working with CBOR.
 It closely mirrors the API for JSON extraction within Actix-Web, and in fact borrows most of it's
 code from Actix-Web.
 
+# Example
+```rust
+use actix_cbor::Cbor;
+
+struct User {
+    name: String,
+}
+struct Greeting {
+    inner: String,
+}
+
+#[get("/users/hello")]
+pub async fn greet_user(user: Cbor<User>) -> Cbor<Greeting> {
+    let name: &str = &user.name;
+    let inner: String = format!("Hello {}!", name);
+    Cbor(Greeting { inner })
+}
+```
+
 # Contributing
 If you have a bug report or feature request, create a new GitHub issue.
 

src/lib.rs

@@ -1,3 +1,22 @@
+//! # Example
+//! ```
+//! use actix_cbor::Cbor;
+//!
+//! struct User {
+//!     name: String,
+//! }
+//! struct Greeting {
+//!     inner: String,
+//! }
+//!
+//! #[get("/users/hello")]
+//! pub async fn greet_user(user: Cbor<User>) -> Cbor<Greeting> {
+//!     let name: &str = &user.name;
+//!     let inner: String = format!("Hello {}!", name);
+//!     Cbor(Greeting { inner })
+//! }
+//! ```
+
 #[cfg(test)]
 #[macro_use]
 extern crate serde;