README.md in lookbook-0.9.6 vs README.md in lookbook-0.9.7

- old
+ new

@@ -1,7 +1,7 @@ <div align="center"> -<h1>👀 Lookbook 👀</h1> +<h1>Lookbook</h1> <p>A native development UI for <a href="http://viewcomponent.org/">ViewComponent</a></p> <div> <a href="https://rubygems.org/gems/lookbook"><img src="https://badge.fury.io/rb/lookbook.svg" alt="Gem version"> @@ -11,11 +11,13 @@ </div> --- <div align="center"> -<a href="#installing">Installing</a> • <a href="#previews">Previews</a> • <a href="#pages">Pages</a> • <a href="#deployment">Deployment</a> • <a href="#config">Config</a> + +<p><a href="#installing">Installing</a> • <a href="#previews">Previews</a> • <a href="#pages">Pages</a> • <a href="#deployment">Deployment</a> • <a href="#config">Config</a></p> +<p><a href="#beta-info">🚨 Lookbook v1.0 (beta) - testers wanted! 🚨</a></p> </div> --- **Lookbook gives [ViewComponent](http://viewcomponent.org/)-based projects a _ready-to-go_ development UI for navigating, inspecting and interacting with component previews.** @@ -24,19 +26,35 @@ Lookbook uses [RDoc/Yard-style comment tags](#annotating-preview-files) to extend the capabilities of ViewComponent's previews whilst maintaining compatability with the standard preview class format, so you can add or remove Lookbook at any time without having to rework your code. ![Lookbook UI](.github/assets/lookbook_screenshot.png) -### Features -- Tree-style navigation menu with live search/filter -- Resizable preview window for responsive testing -- Highlighted preview source code and HTML output -- Auto-updating UI when component or preview files are updated _(Rails v6.0+ only)_ -- Use comment tag annotations for granular customisation of the preview experience -- Fully compatible with standard the ViewComponent preview system -- In-browser live-editable preview parameters (similar to basic Storybook Controls/Knobs) -- [**Experimental**] Markdown-powerered documentation pages with embeddable previews +<h2 id="beta-info">🚨 Lookbook v1.0 (beta)</h3> + +The Lookbook v1.0 release is coming soon with a bunch of new features and under-the hood improvements. + +### Testing out the beta + +If you are already using Lookbook in your project, just update the Lookbook gem to the latest beta release and then head over to the [beta documentation site](https://beta.lookbook.build/) to read more about the new features. + +```ruby +gem "lookbook", ">= 1.0.0.beta.7" +``` + +If you are **new to Lookbook** then check out the <a href="https://beta.lookbook.build/guide/quick-start/">v1.0 quick start guide</a> for more detailed instructions on installing Lookbook in your project + +> Please do <a href="https://github.com/allmarkedup/lookbook/issues">open an issue</a> or <a href="https://github.com/allmarkedup/lookbook/discussions">start a discussion</a> if you need any help with anything. Comments, feedback and suggestions are always appreciated! + +<h4>Useful Resources</h4> + +* 👉 <a href="https://lookbook-demo-app-v1-0-beta.herokuapp.com/lookbook">v1.0 demo app</a> <em>(The repo for the demo app <a href="https://github.com/allmarkedup/lookbook-demo/tree/v1.0-beta">is here</a> if you want to dig in further)</em> +* 👉 <a href="https://beta.lookbook.build/">v1.0 documentation site</a> _(work in progress!)_ +* 👉 <a href="https://github.com/allmarkedup/lookbook/tree/v1.0-beta">v1.0-beta branch</a> + +--- + +**⚠️ Note: The rest of the documentation on this page is related to the current, stable `v0.9.x` branch.** ## 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.