Skip to content

Commit 45310bf

Browse files
authored
Only require the package for dev environments by default.
Given that the API docs are just static files, the generator does not need to be shipped in production environments. Therefore, this change updates the `composer require` command in the README to only require the package in dev environments.
1 parent 573e9ef commit 45310bf

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Automatically generate your API documentation from your existing Laravel/Lumen/[
1515
PHP 7 and Laravel 5.5 or higher are required.
1616

1717
```sh
18-
composer require mpociot/laravel-apidoc-generator
18+
composer require --dev mpociot/laravel-apidoc-generator
1919
```
2020

2121
### Laravel
@@ -28,6 +28,7 @@ php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProv
2828
This will create an `apidoc.php` file in your `config` folder.
2929

3030
### Lumen
31+
- When using Lumen, you will need to run `composer require mpociot/laravel-apidoc-generator` instead.
3132
- Register the service provider in your `bootstrap/app.php`:
3233

3334
```php

0 commit comments

Comments
 (0)