From 733f61f48ae7fe3535f3c5ece25b366125d36f40 Mon Sep 17 00:00:00 2001
From: ulrik nielsen <ulrik@o3.dk>
Date: Mon, 19 May 2014 11:07:59 +0200
Subject: [PATCH] updated readme

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 55 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 97f320f..52b35c0 100644
--- a/README.md
+++ b/README.md
@@ -14,11 +14,11 @@ This bundle allows you to integrate [kraken.io](https://kraken.io/) into your Sy
                 "pompdelux/kraken-bundle": "1.x"
             }
         }
-2. Use Composer to download and install the bundle: 
+2. Use Composer to download and install the bundle:
 
         $ php composer.phar update pompdelux/kraken-bundle
 3. Register the bundle in your application:
-        
+
         // app/AppKernel.php
         class AppKernel extends Kernel
         {
@@ -32,4 +32,57 @@ This bundle allows you to integrate [kraken.io](https://kraken.io/) into your Sy
             }
         }
 
+4. Add the configuration needed to use the bundle:
+
+        // config.yml
+        kraken:
+            services:
+                service_name:
+                    api_key:    your-kraken.io-key
+                    api_secret: your-kraken.io-secret
+
+## Usage:
+
+### Basic example:
+
+```php
+$kraken = $this->container->get('pompdelux.kraken.service_name');
+$result = $kraken->squeeze('http://example.com/some/public/image.jpg');
+```
+
+### Example with callback rather than wait strategy:
+
+```yml
+# config.yml
+kraken:
+    services:
+        ...
+        callback_service:
+            api_key:        your-kraken.io-key
+            api_secret:     your-kraken.io-secret
+            callback:       true
+            callback_route: your_callback_route
+
+# routing.yml
+acme_kraken_callback:
+    pattern: /my/kraken/callback
+    defaults: { _controller: AcmeTestBundle:Kraken:callback }
+    requirements:
+        _method:  POST
+
+```
+
+```php
+
+$kraken = $this->container->get('pompdelux.kraken.callback_service');
+$result = $kraken->squeeze('http://example.com/some/public/image.jpg');
 
+// In AcmeTestBundle/Controller/KrakenController.php
+//
+// this method will be called once kraken.io is done processing your image.
+public function callbackAction(Request $request)
+{
+    error_log(print_r($request->getContent(), 1));
+    return new Response();
+}
+```