Skip to content

Commit

Permalink
readme file updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Rukhsar committed Dec 13, 2016
1 parent 618dbd7 commit b8a7664
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
@@ -1,4 +1,30 @@
## Laravel PackMe
-

A laravel command to generate a laravel starting package
A laravel command to generate a laravel starting package, it just provide a basic skeleton. It include a complete boilerplate code, just keep what you want remove the remaining.

## Installation

Install this package via composer

```bash
composer require rukhsar/laravel-packme
```

Then add the service provider to you provider's array in `config/app.php`

```php
Rukhsar\PackMe\PackMeServiceProvider::class,
```

## Usage
-

It will create a packages directory, creates the vendor and package directory in it, pulls in a skeleton package, sets up composer.json, creates a service provider, registers the package in config/app.php and the app's composer.json. So you can start right away with only this command:

```bash
php artisan pack:me vendor_name package_name
```

-
This project is open-sourced software licensed under the [MIT](https://opensource.org/licenses/MIT) License.

0 comments on commit b8a7664

Please sign in to comment.