diff --git a/readme.md b/readme.md index 5067bec..6e2076c 100644 --- a/readme.md +++ b/readme.md @@ -12,10 +12,6 @@ A Laravel package for [opensoft/rollout](https://github.com/opensoft/rollout) composer require jaspaul/laravel-rollout ``` -### Setting up a Cache - -Be sure to [enable the cache](https://laravel.com/docs/5.4/cache) for your Laravel application. This package uses the cache to store the rollout settings. - ### Configuring the Service Provider Open config/app.php and register the required service provider above your application providers. @@ -28,6 +24,33 @@ Open config/app.php and register the required service provider above your applic ] ``` +### Setting up Storage + +#### Publish the Configuration + +```sh +php artisan vendor:publish --provider 'Jaspaul\LaravelRollout\ServiceProvider' +``` + +#### Setting up a Cache + +Be sure to [enable the cache](https://laravel.com/docs/5.4/cache) for your Laravel application. This package uses the cache to store the rollout settings. + +#### Setting up Persistent Storage + +##### Running the Migrations + +```sh +php artisan migrate +``` + +##### Configuring your Environment + +``` +ROLLOUT_STORAGE=database +ROLLOUT_TABLE=rollout +``` + ### Implementing Interfaces Your rollout users must implement the `\Jaspaul\LaravelRollout\Helpers\User` interface. Often this will be your main user object: