From 423ba645b4e8668fdeda6530e23b5bb6321f7964 Mon Sep 17 00:00:00 2001 From: Oliver Vogel Date: Mon, 25 Feb 2013 19:04:31 +0100 Subject: [PATCH] textual improvments of the documentation --- README.md | 20 ++++++++++++++------ composer.json | 2 +- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4367c03e..36df01e3 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,34 @@ # Intervention Image Class -Image handling and manipulation based on PHP GD library. Made to work with **Laravel 4** but runs also standalone. +Intervention Image Class is an image handling and manipulation wrapper library using **PHP GD library**. The class is written to make PHP image manipulating more easier and expressive. + +The library requires at least **PHP version 5.3** and comes with **Laravel 4** Facades and Service Providers to simplify the optional framework integration. ## Installation -You can install this Image class quick and easy with Composer. +You can install this Image class quickly and easily with Composer. Require the package via Composer in your `composer.json`. "intervention/image": "dev-master" -Run Composer to update the new requirement. +Run Composer to install or update the new requirement. $ composer update -The Image class are built to work with the Laravel 4 Framework. The integration is done in seconds. +Now you are able to require the `vendor/autoload.php` file to PSR-0 autoload the library. + +### Laravel 4 Integration + +The Image class also has optional Laravel 4 support. The integration into the framework is done in seconds. Open your Laravel config file `config/app.php` and add the following lines. In the `$providers` array add the service providers for this package. 'providers' => array( - ... + + [...] 'Intervention\Image\ImageServiceProvider' ), @@ -30,7 +37,8 @@ In the `$providers` array add the service providers for this package. Add the facade of this package to the `$aliases` array. 'aliases' => array( - ... + + [...] 'Image' => 'Intervention\Image\Facades\Image' ), diff --git a/composer.json b/composer.json index 87d15810..7329c7a5 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "intervention/image", - "description": "Image handling and manipulation for Laravel 4", + "description": "Image handling and manipulation library with support for Laravel 4 integration", "homepage": "https://github.com/Intervention/image", "keywords": ["image", "gd", "laravel"], "license": "MIT",