diff --git a/README.md b/README.md index c5afcc8..2fca48b 100755 --- a/README.md +++ b/README.md @@ -1,34 +1,40 @@ -**Inverse seed generator (iSeed)** is a Laravel 4 package that provides a method to generate a new seed file based on data from the existing database table. +**Inverse seed generator (iSeed)** is a Laravel package that provides a method to generate a new seed file based on data from the existing database table. [![Build Status](https://travis-ci.org/orangehill/iseed.png)](http://travis-ci.org/orangehill/iseed) [![Latest Stable Version](https://poser.pugx.org/orangehill/iseed/v/stable.png)](https://packagist.org/packages/orangehill/iseed) [![Total Downloads](https://poser.pugx.org/orangehill/iseed/downloads.png)](https://packagist.org/packages/orangehill/iseed) ## Installation -1) Edit your project's `composer.json` file to require `orangehill/iseed`. +1) For Laravel 5 instalation edit your project's `composer.json` file to require `orangehill/iseed`. "require": { - "laravel/framework": "4.0.*", "orangehill/iseed": "dev-master" } -2) Update Composer from the CLI: +If you wish to install it on Laravel 4 you should require 1.1 version: - composer update + "require": { + "orangehill/iseed": "1.1" + } -3) Once this operation completes, add the service provider by opening a `app/config/app.php` file, and adding a new item to the `providers` array. +2) Add the service provider by opening a `app/config/app.php` file, and adding a new item to the `providers` array. 'Orangehill\Iseed\IseedServiceProvider' +3) Update Composer from the CLI: + + composer update + + ## Usage To generate a seed file for your users table simply call: `\Iseed::generateSeed('users', 'connectionName', 'numOfRows');`. `connectionName` and `numOfRows` are not required arguments. -This will create a file inside a `/app/database/seeds`, with the contents similar to following example: +This will create a file inside a `/database/seeds` (`/app/database/seeds` for Laravel 4), with the contents similar to following example: