From c54b36d0bf75ade0e8b38015ae56d06b38a6408d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1s=20Aparicio?= <tomas@aparicio.me>
Date: Wed, 1 Apr 2015 12:57:09 +0200
Subject: [PATCH] feat(docs): add API example

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eefc223..a9ac813 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,42 @@
 # bimg
 
-Go library for blazing fast image processing based on [libvips](https://github.com/jcupitt/libvips)
+Go library for blazing fast image processing based on [libvips](https://github.com/jcupitt/libvips) using C bindings
 
 `Work in progress`
 
+## Installation
+
+```bash
+go get gopkg.in/h2non/bimg.v0
+```
+
+Or get the lastest development version
+```bash
+go get github.com/h2non/bimg
+```
+
+## API
+
+```go
+import (
+  "fmt"
+  "os"
+  "gopkg.in/h2non/bimg"
+)
+
+options := bimg.Options{
+    Width:        800,
+    Height:       600,
+    Crop:         true,
+    Quality:      95,
+}
+
+newImage, err := bimg.Resize(image, options)
+if err != nil {
+  fmt.Fprintln(os.Stderr, err)
+}
+```
+
 ## License
 
 MIT - Tomas Aparicio