chore: README

Zmyslny · Zmyslny · commit e30ee3f37206 · 2025-10-02T21:15:44.000+02:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 A Laravel package that provides a simple way to wrap your JavaScript code stored in a file and inline it as custom Blade directive.  
 
-Allows:
+Allows ✨:
 - passing variables from PHP to JavaScript,
 - process / modify the script in a dedicated PHP class.
 
@@ -23,7 +23,7 @@ Install the package via Composer:
 composer require zmyslny/laravel-inline-scripts
 ```
 
-Register a custom Blade directive for your JavaScript file or files, typically in a service provider `AppServiceProvider`:
+Register a custom Blade directive for your JavaScript in your `AppServiceProvider`:
 
 ```php
 class AppServiceProvider extends ServiceProvider 
@@ -52,6 +52,8 @@ Use the Blade directive in your template to inline the scripts:
     ...
 ```
 
+Done.
+
 ### What are Inline Scripts?
 
 Inline scripts are JavaScript code blocks embedded directly into HTML documents. Traditionally, developers manually write these scripts as strings in the `<head>` section or at the end of the `<body>` section:
@@ -71,15 +73,15 @@ This package makes it much more convenient by allowing you to keep inline script
 
 - **Complex script processing** using dedicated PHP classes _(see example below)_
 - **Variable passing** from PHP to JavaScript _(see example below)_
-- **Unit testing** your JavaScript code using tools like Vitest or Jest _(see example below)_
+- **Unit testing** your JavaScript code using tools like Vitest or Jest _(see extra section below)_
 - **Better code organization** and maintainability
 - **IDE support** with syntax highlighting and error detection in dedicated JS files
 
 # Explanation Through Example: Theme switch script
 
 Modern websites often provide users with the ability to switch between light and dark themes. In such cases, you might want to remember the user's choice using `localStorage` and apply the selected theme on page load. To avoid **FOUC** (Flash of Unstyled Content), you can use _inline script_ to set the theme before the page fully loads.
 
-Step 1: Publish the built-in theme switch scripts:
+**Step 1**: Publish the built-in theme switch scripts:
 
 ```bash
 php artisan vendor:publish --tag=theme-switch-2-states-js
@@ -89,7 +91,7 @@ That will copy the scripts to `resources/js/theme-switch-two-states/[theme-init.
 `theme-init.js` - initializes the theme based on the user's previous choice stored in `localStorage`.  
 `theme-switch.js` - a function to toggle between light and dark themes by hitting a selected KEY and saves the choice in `localStorage`.
 
-Step 2: Register the scripts in your `AppServiceProvider`:
+**Step 2**: Register the scripts in your `AppServiceProvider`:
 
 ```php
 class AppServiceProvider extends ServiceProvider 
@@ -110,7 +112,7 @@ class AppServiceProvider extends ServiceProvider
 }
 ```
 
-Step 3: Use the Blade directive in your template:
+**Step 3**: Use the Blade directive in your template:
 
 ```blade
 <html>
@@ -132,15 +134,15 @@ Create a custom PHP processor class implementing the `RenderableScript` or `Scri
 
 We have a built-in processor for the theme switch scripts as well. To use it, follow these steps:
 
-Step 1: Publish the built-in theme switch scripts with the PHP processor:
+**Step 1**: Publish the built-in theme switch scripts with the PHP processor:
 
 ```bash
 php artisan vendor:publish --tag=theme-switch-2-states-php
 ```
 
-That will copy the scripts to `resources/js/theme-switch-two-states/[theme-init.js, theme-switch.js]` and the processor class to `app/Blade/ThemeSwitchTwoStates/[ThemeInitScript.php, ThemeSwitchScript]`.
+That will copy the scripts to `resources/js/theme-switch-two-states/[theme-init.js, theme-switch.js]` and the processors classes to `app/Blade/ThemeSwitchTwoStates/[ThemeInitScript.php, ThemeSwitchScript]`.
 
-Step 2: Register the scripts in your `AppServiceProvider`:
+**Step 2**: Register the scripts in your `AppServiceProvider`:
 
 ```php
 class AppServiceProvider extends ServiceProvider 
@@ -155,7 +157,7 @@ class AppServiceProvider extends ServiceProvider
 }
 ```
 
-Step 3: Use the Blade directive in your template as previously shown.
+**Step 3**: Use the Blade directive in your template as previously shown.
 
 Now hit the `d` key to toggle theme.
 
@@ -166,7 +168,13 @@ php artisan vendor:publish --tag=theme-switch-2-states-js-tests
 php artisan vendor:publish --tag=theme-switch-2-states-php-tests
 ```
 
-### License
+You can also publish all the assets mentioned at once:
+
+```bash
+php artisan vendor:publish --tag=theme-switch-2-states-all
+```
+
+## License
 
 This package is licensed under the MIT License.
 
