From 6f16b2a1e73961a3d2f502f90d09acc3414416b5 Mon Sep 17 00:00:00 2001 From: Jorge Manrubia Date: Wed, 25 Dec 2024 13:12:19 +0100 Subject: [PATCH] Update README --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 60d89b7..12c67f7 100644 --- a/README.md +++ b/README.md @@ -52,17 +52,24 @@ You can set configuration options on your `development.rb`. For example: config.hotwire.spark.html_paths += %w[ lib ] ``` +### General + | Name | Description | |-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `html_paths` | Paths where file changes trigger a content refresh. By default: `app/controllers`, `app/helpers`, `app/models`, `app/views`. | -| `css_paths` | Paths where file changes trigger a CSS refresh. By default: `app/assets/stylesheets` or `app/assets/builds` if exists. | -| `stimulus_paths` | Paths where file changes trigger a Stimulus controller refresh. By default: `app/javascript/controllers`. | | `enabled` | Enable or disable live reloading. By default, it's only enabled in `development`. | | `logging` | Show logs in the browser console when reloading happens. It's false by default. | | `html_reload_method` | How to perform reloads when HTML content changes: `:morph` or `:replace`. By default, it is `:morph` and it will morph the `` of the page and reload all the stimulus controllers. Set to `:replace` to reload the page with a regular Turbo navigation that will replace the `` and keep the scroll. | -| `html_extensions` | The extensions to monitor for HTML content changes. By default: `rb`, `erb`. | | -| `css_extensions` | The extensions to monitor for CSS changes. By default: `css`. | | -| `stimulus_extensions` | The extensions to monitor for Stimulus changes. By default: `js`. | | + +### Monitored paths + +| Name | Description | +|-----------------------|------------------------------------------------------------------------------------------------------------------------------| +| `html_paths` | Paths where file changes trigger a content refresh. By default: `app/controllers`, `app/helpers`, `app/models`, `app/views`. | +| `css_paths` | Paths where file changes trigger a CSS refresh. By default: `app/assets/stylesheets` or `app/assets/builds` if exists. | +| `stimulus_paths` | Paths where file changes trigger a Stimulus controller refresh. By default: `app/javascript/controllers`. | +| `html_extensions` | The extensions to monitor for HTML content changes. By default: `rb`, `erb`. | | +| `css_extensions` | The extensions to monitor for CSS changes. By default: `css`. | | +| `stimulus_extensions` | The extensions to monitor for Stimulus changes. By default: `js`. | | ## License