From c2300b02cf2a8e987a6477a601684afe089ed920 Mon Sep 17 00:00:00 2001
From: Nathan Fiedler <nathanfiedler@fastmail.fm>
Date: Thu, 8 Oct 2015 06:52:41 -0700
Subject: [PATCH] Add creates details and example usage

---
 Cargo.toml |  6 ++++++
 README.md  | 23 +++++++++++++++++++++++
 2 files changed, 29 insertions(+)

diff --git a/Cargo.toml b/Cargo.toml
index 82376ca..3569683 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,6 +2,12 @@
 name = "magick_rust"
 version = "0.2.0"
 authors = ["Nathan Fiedler <nathanfiedler@fastmail.fm>"]
+description = "Selection of Rust bindings for the ImageMagick library."
+homepage = "https://github.com/nlfiedler/magick-rust"
+repository = "https://github.com/nlfiedler/magick-rust.git"
+readme = "README.md"
+license = "Apache-2.0"
+keywords = ["magickwand", "imagemagick"]
 
 [dependencies]
 libc = "0.1.8"
diff --git a/README.md b/README.md
index 2718093..6f1c966 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,29 @@ $ cargo build
 $ cargo test
 ```
 
+## Example Usage
+
+MagickWand has some global state that needs to be initialized prior to using the library, but fortunately Rust makes handling this pretty easy. In the example below, we read in an image from a file and resize it to fit a square of 240 by 240 pixels, then convert the image to JPEG.
+
+```
+use magick_rust::{MagickWand, magick_wand_genesis};
+use std::sync::{Once, ONCE_INIT};
+
+// Used to make sure MagickWand is initialized exactly once. Note that we
+// do not bother shutting down, we simply exit when we're done.
+static START: Once = ONCE_INIT;
+
+fn resize() -> Result<Vec<u8>, &'static str> {
+    START.call_once(|| {
+        magick_wand_genesis();
+    });
+    let wand = MagickWand::new();
+    try!(wand.read_image("kittens.jpg"));
+    wand.fit(240, 240);
+    wand.write_image_blob("jpeg")
+}
+```
+
 ## Generating Bindings
 
 To generate the ImageMagick bindings, we use [rust-bindgen](https://github.com/crabtw/rust-bindgen), which reads the C header files and produces a suitable wrapper in Rust.