update readme

Author: stevethomas

README.md

@@ -1,42 +1,46 @@
-# Dynamic feature flags for laravel.
+# Dynamic Feature Flags for Laravel
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/codinglabsau/laravel-feature-flags.svg?style=flat-square)](https://packagist.org/packages/codinglabsau/laravel-feature-flags)
 [![Test](https://github.com/codinglabsau/laravel-feature-flags/actions/workflows/run-tests.yml/badge.svg)](https://github.com/codinglabsau/laravel-feature-flags/actions/workflows/run-tests.yml)
 [![Total Downloads](https://img.shields.io/packagist/dt/codinglabsau/laravel-feature-flags.svg?style=flat-square)](https://packagist.org/packages/codinglabsau/laravel-feature-flags)
 
-This package offers the ability to implement feature flags in your application which can be easily toggled on or off. You can also set a feature to a dynamic state where you can define custom rules around whether that feature is enabled or not.
+This package allows instant, zero-deployment toggling of application features.
+
+Individual features can be in one of three states:
+- On: enabled for everyone
+- Off: disabled for everyone
+- Dynamic: evaluated according to a custom or default callback
+
 ___
 ## Installation
 
-### Install With Composer:
-
+### Install With Composer
 ```bash
 composer require codinglabsau/laravel-feature-flags
 ```
 
 ### Database Migrations
-
 ```bash
 php artisan vendor:publish --tag="feature-flags-migrations"
 php artisan migrate
 ```
 
-### Publish Configuration:
-
+### Publish Configuration
 ```bash
 php artisan vendor:publish --tag="feature-flags-config"
 ```
 
+### Set Your Cache Store
+This package caches the state of features to reduce redundant database queries. The cache is expired whenever the feature state changes.
 
-### Cache Store
-update your `.env`:
-```php
+By default, this package will use the default cache configured in your application.
+
+If you wish to change to a different cache driver, update your `.env`:
+```
 FEATURES_CACHE_STORE=file
 ```
-Note that under the hood this package uses the `rememberForever()` method for caching and that if you are using the `Memcached` driver, items that are stored "forever" may be removed when the cache reaches its size limit.
 
 ### Use Your Own Model
-
 To use your own model, update the config and replace the existing reference with your own model:
 
 ```php
@@ -58,7 +62,6 @@ protected $casts = [
 ```
 
 ## Usage
-
 Create a new feature in the database and give it a default state:
 ```php
 Feature::create([
@@ -99,47 +102,6 @@ if (FeatureFlag::isEnabled('search-v2')) {
 }
 ```
 
-#### Sharing features with UI (Inertiajs example)
-```php
-// config/app.php
-
-'features' => [
-    [
-        'name' => 'search-v2',
-        'state' => \Codinglabs\FeatureFlags\Enums\FeatureState::dynamic()
-    ]
-],
-```
-
-```php
-// app/Middleware/HandleInertiaRequest.php
-
-Inertia::share([
-    'features' => function () {
-        return collect(config('app.features'))
-            ->filter(fn ($feature) => FeatureFlag::isEnabled($feature['name']))
-            ->pluck('name');
-    }
-]);
-```
-
-```javascript
-// app.js
-
-Vue.mixin({
-  methods: {
-    hasFeature: function(feature) {
-      return this.$page.features.includes(feature)
-    }
-  }
-})
-```
-```html
-<!-- SomeComponent.vue -->
-
-<div v-if="hasFeature('search-v2')">Some cool new feature</div>
-```
-
 ### Updating A Features State
 
 To change a features state you can call the following methods:
@@ -163,9 +125,7 @@ An example use case of the feature updated event would be if you were caching th
 
 ___
 ## Advanced Usage
-
 ### Dynamic Features
-
 A dynamic handler can be defined in the `boot()` method of your `AppServiceProvider`:
 ```php
 use Codinglabs\FeatureFlags\Facades\FeatureFlag;
@@ -179,7 +139,6 @@ Dynamic handlers will only be called when a feature is in the `dynamic` state. T
 Each handler is provided with the features name and current request as arguments and must return a bool value.
 
 ### Default Handler For Dynamic Features
-
 You may also define a default handler which will be the catch-all handler for features that don't have an explicit handler defined for them:
 
 ```php
@@ -191,7 +150,6 @@ FeatureFlag::registerDefaultDynamicHandler(function ($feature, $request) {
 An explicit handler defined using `registerDynamicHandler()` will take precedence over the default handler. If neither a default nor explicit handler has been defined then the feature will resolve to `off` by default.
 
 ### Handle Missing Features
-
 Features must exist in the database otherwise a `MissingFeatureException` will be thrown. This behaviour can be turned off by explicitly handling cases where a feature doesn't exist:
 
 ```php
@@ -202,21 +160,58 @@ FeatureFlag::handleMissingFeaturesWith(function ($feature) {
 
 If a handler for missing features has been defined then an exception will **not** be thrown and the feature will resolve to `off`.
 
-## Testing
+### Sharing features with UI (Inertiajs example)
+```php
+// config/app.php
 
+'features' => [
+    [
+        'name' => 'search-v2',
+        'state' => \Codinglabs\FeatureFlags\Enums\FeatureState::dynamic()
+    ]
+],
+```
+
+```php
+// app/Middleware/HandleInertiaRequest.php
+
+Inertia::share([
+    'features' => function () {
+        return collect(config('app.features'))
+            ->filter(fn ($feature) => FeatureFlag::isEnabled($feature['name']))
+            ->pluck('name');
+    }
+]);
+```
+
+```javascript
+// app.js
+
+Vue.mixin({
+  methods: {
+    hasFeature: function(feature) {
+      return this.$page.features.includes(feature)
+    }
+  }
+})
+```
+```html
+<!-- SomeComponent.vue -->
+
+<div v-if="hasFeature('search-v2')">Some cool new feature</div>
+```
+
+## Testing
 ```bash
 composer test
 ```
 
 ## Security Vulnerabilities
-
 Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
 
 ## Credits
-
 - [Jonathan Louw](https://github.com/JonathanLouw)
 - [All Contributors](../../contributors)
 
 ## License
-
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.