From 421e1827c099143856ddef5c24b8e8299c75be6a Mon Sep 17 00:00:00 2001 From: Gregory McLean Date: Thu, 8 Sep 2011 09:12:30 -0400 Subject: [PATCH] Clarify instructions and fix some typos. --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 51 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 67b0534..8cd9c99 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,75 @@ Gregwar's CaptchaBundle ===================== -`GregwarCaptchaBundle` provides the form type "captcha" +The `GregwarCaptchaBundle` adds support for a "captcha" form type for the +Symfony2 form component. Installation ============ -To install `GregwarCaptchaBundle`, first adds it to your `deps`: +### Step 1: Download the GregwarCaptchaBundle +Ultimately, the GregwarCaptchaBundle files should be downloaded to the +'vendor/bundles/Gregwar/CaptchaBundle' directory. + +You can accomplish this several ways, depending on your personal preference. +The first method is the standard Symfony2 method. + +**Using the vendors script ** + +Add the following lines to your `deps` file: + +``` [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 - __DIR__.'/../vendor/bundles', -... ``` -And registers the bundle in your `app/AppKernel.php`: +Now, run the vendors script to download the bundle: + +``` bash +$ php bin/vendors install +``` + +***Using submodules*** +If you prefer instead to use git submodules, then run the following: + +``` bash +$ git submodule add git://github.com/Gregwar/CaptchaBundle.git vendor/bundles/Gregwar/CaptchaBundle +$ git submodule update --init +``` + +### Step 2: Configure the Autoloader + +Now you will need to add the `Gregwar` namespace to your autoloader: + +``` php +registerNamspaces(array( + // ... + 'Gregwar' => __DIR__.'/../vendor/bundles', +)); +``` +### Step 3: Enable the bundle + +Finally, enable the bundle in the kernel: ```php