Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Add Usage Description #2

Merged
merged 2 commits into from
Aug 9, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,47 @@
[![Travis](https://img.shields.io/travis/naoray/laravel-package-maker.svg?style=flat-square)]()
[![Total Downloads](https://img.shields.io/packagist/dt/naoray/laravel-package-maker.svg?style=flat-square)](https://packagist.org/packages/naoray/laravel-package-maker)

Developing packages with laravel is easy, but the process of creating the project folders, initializing composer, readme
contribution guide, ... You get the point. This Package comes with two useful commands to create/use packages locally and serves as a quick package stub generator. With only one command you can create a new package with
- Ready to use Composer file
- License file (currently only MIT)
- Contribution guidelines
- .travis.yml
- phpunit.xml
- .styleci.yml
- .gitignore
- tests folder
- base TestCase Class using Orchestra Testbench
- Service Provider

... and your newly created package gets directly pulled in your project via composer repositories.

```
php artisan make:package
```

![make:package command](https://user-images.githubusercontent.com/10154100/43901805-b14e9e02-9be8-11e8-9617-6999509fb0d5.png)

## Install
`composer require naoray/laravel-package-maker`
`composer require naoray/laravel-package-maker --dev`

## Usage
Write a few lines about the usage of this package.
### Creating a new package
*To see all arguments/options available for make:package just type `php artisan package:make -h`*
```
php artisan make:package
```

![make:package command](https://user-images.githubusercontent.com/10154100/43901805-b14e9e02-9be8-11e8-9617-6999509fb0d5.png)

### Adding a package
If you have already created a package or you want to add a modified version of a package which is currently only available locally, you can use the following command to add you package to your project.

```
php artisan package:add
```

![package:add command](https://user-images.githubusercontent.com/10154100/43901825-bc2fb91e-9be8-11e8-9142-c44558c9303c.png)

## Testing
Run the tests with:
Expand Down
2 changes: 1 addition & 1 deletion tests/TestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class TestCase extends Orchestra
protected function getPackageProviders($app)
{
return [
\Naoray\LaravelPackageMaker\LaravelPackageServiceProvider::class,
\Naoray\LaravelPackageMaker\LaravelPackageMakerServiceProvider::class,
];
}

Expand Down