README.md in lookbook-0.3.0 vs README.md in lookbook-0.3.1
- old
+ new
@@ -25,13 +25,13 @@
- Tree-style navigation menu
- Live nav search/filter
- Resizable preview window for responsive testing
- Highlighted preview source code and HTML output
- Add notes via comments in the preview file (markdown supported)
-- Auto-updating UI when component or preview files are updated
-- Supports 'hidden' previews and examples
-- Works with standard the ViewComponent preview system
+- Auto-updating UI when component or preview files are updated _(Rails v6.0+ only)_
+- Hide, group and rename preview examples using comment tags
+- Fully compatible with standard the ViewComponent preview system
## Lookbook demo
If you want to have a quick play with Lookbook, the easiest way is to [give the demo app](https://github.com/allmarkedup/lookbook-demo) a spin. It's a basic Rails/ViewComponent app with a few test components included to tinker with.
@@ -245,9 +245,11 @@
Lookbook will use the ViewComponent [configuration](https://viewcomponent.org/api.html#configuration) for your project to find and render your previews so you generally you won't need to configure anything separately.
However the following Lookbook-specific config options are also available:
### UI auto-refresh
+
+> ⚠️ UI auto-refresh is only supported in Rails v6.0+
Disable/enable the auto-updating of the Lookbook UI when files change. Enabled by default.
```ruby
config.lookbook.auto_refresh = false # default is true