From e9e2cf5179cc3d8880dfcbfc4e9031181be707b8 Mon Sep 17 00:00:00 2001
From: Gregwar <g.passault@gmail.com>
Date: Thu, 25 Aug 2011 23:13:27 +0200
Subject: [PATCH] Added README

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57976ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+Gregwar's CaptchaBundle
+=====================
+
+`GregwarCaptchaBundle` provides the form type "captcha"
+
+Installation
+============
+
+To install `GregwarCaptchaBundle`, first adds it to your `deps`:
+
+    [GregwarCaptchaBundle]
+        git=git://github.com/Gregwar/CaptchaBundle.git
+        target=/bundles/Gregwar/CaptchaBundle
+
+And run `php bin/vendors install`. Then add the namespace to your `app/autoload.php` 
+file:
+
+```php
+<?php
+...
+'Gregwar' => __DIR__.'/../vendor/bundles',
+...
+```
+
+And registers the bundle in your `app/AppKernel.php`:
+
+```php
+<?php
+//...
+public function registerBundles()
+{
+    $bundles = array(
+        ...
+        new Gregwar\CaptchaBundle\GregwarCaptchaBundle(),
+        ...
+    );
+...
+```
+
+Adds the following configuration to your `app/config/config.yml`:
+
+    gregwar_captcha: ~
+
+Usage
+=====
+
+You can use the "captcha" type in your forms this way:
+
+```php
+<?php
+    // ...
+    $builder->add('captcha', 'captcha'); // That's all !
+    // ...
+```
+
+Note that the generated image will be embeded in the HTML document, to avoid dealing
+with route and subrequests.
+
+License
+=======
+
+This bundle is under MIT license