Add docs about some config options

Author: Voltra

README.md

@@ -14,7 +14,7 @@
 |------|----------|--------|
 | [1.x](https://github.com/z3d0x/filament-fabricator/tree/1.x) | ^2.0 | ^8.0 |
 | [2.x](https://github.com/z3d0x/filament-fabricator/tree/2.x) | ^3.0 | ^8.1 |
-| [3.x](https://github.com/z3d0x/filament-fabricator/tree/3.x) | ^3.0 | ^8.2 |
+| [3.x](https://github.com/z3d0x/filament-fabricator/tree/3.x) | ^4.0 | ^8.2 |
 
 ## Installation
 

docs/README.md

@@ -253,16 +253,16 @@ an alternative one-liner way of changing block picker style is using `blockPicke
 ```php
 use Z3d0X\FilamentFabricator\Enums\BlockPickerStyle;
 use Z3d0X\FilamentFabricator\FilamentFabricatorPlugin;
- 
+
 //..
- 
+
 public function panel(Panel $panel): Panel
 {
     return $panel
         // ...
         ->plugins([
             FilamentFabricatorPlugin::make()
-                ->blockPickerStyle(BlockPickerStyle::Modal), 
+                ->blockPickerStyle(BlockPickerStyle::Modal),
         ]);
 }
 ```
@@ -306,9 +306,57 @@ class AuthServiceProvider extends ServiceProvider
 ```
 > If you are using [Shield](https://filamentphp.com/plugins/bezhansalleh-shield) just register the `PagePolicy` generated by it
 
+## Caching
+
+By default, routes will be cached in a lazy manner. That means that a page needs to be hit before it's cached.
+
+If you so choose, you can also force all pages to be cached by running the following command:
+```bash
+php artisan filament-fabricator:clear-routes-cache
+```
+
+By running the following command instead, you'll ensure the data is fresh before it's cached:
+```bash
+php artisan filament-fabricator:clear-routes-cache --refresh
+```
+
+## Configuration
+
+### Auto-routing
+
+By default, your pages' routing will be done automatically for you so you don't have to worry about it.
+
+To do that the package registers a fallback route which, when hit, will render your page.
+
+If you want manual control over how your pages are rendered, you can disable this by setting the `routing.enabled` config option in your config file to `false`.
+
+### Route prefix
+
+If you so desire, you can add a prefix to be used in all your pages' routes. This is used in conjunction with auto-routing.
+
+For instance: If a page has a slug `page-1`, and the prefix is set to `/pages`, then you'll access that page at the URL `/pages/page-1`.
+
+> **Warning:** When changing the route prefix in the config, you'll want to run the `php artisan filament-fabricator:clear-routes-cache --refresh` command
+
+### Hooking the route cache into Laravel's lifecycle
+
+By default routes are properly cached, cleared, and refreshed whenever you would expect it to.
+
+This is achieved by hooking into the following core commands:
+
+- `cache:clear`        -> clear routes cache
+- `config:cache`       -> refresh routes cache
+- `config:clear`       -> clear routes cache
+- `optimize`           -> refresh routes cache
+- `optimize:clear`     -> clear routes cache
+- `route:clear`        -> clear routes cache
+
+If you don't want this behavior, you can opt out of it by setting the `hook-to-commands` config option to `false` in your config file.
+
 
 ## Compatibility
 | Fabricator | Filament | PHP |
 |------|----------|--------|
 | [1.x](https://github.com/z3d0x/filament-fabricator/tree/1.x) | ^2.0 | ^8.0 |
 | [2.x](https://github.com/z3d0x/filament-fabricator/tree/2.x) | ^3.0 | ^8.1 |
+| [3.x](https://github.com/z3d0x/filament-fabricator/tree/3.x) | ^4.0 | ^8.2 |

src/Listeners/OptimizeWithLaravel.php

@@ -9,7 +9,7 @@
 
 class OptimizeWithLaravel
 {
-    const COMMANDS = [
+    public const COMMANDS = [
         'cache:clear',
         'config:cache',
         'config:clear',
@@ -18,7 +18,7 @@ class OptimizeWithLaravel
         'route:clear',
     ];
 
-    const REFRESH_COMMANDS = [
+    public const REFRESH_COMMANDS = [
         'config:cache',
         'optimize',
     ];