README.md in lookbook-1.5.5 vs README.md in lookbook-2.0.0.beta.0

- old
+ new

@@ -1,60 +1,42 @@ <br> -<img alt="Lookbook Logo" src=".github/assets/lookbook_logo.svg" width="180"> +<img src=".github/assets/lookbook_logo.svg" width="180"> -A tool to help browse, develop, test & document [ViewComponents](https://viewcomponent.org/) in Ruby on Rails apps. +Lookbook is a **UI development environment** for Ruby on Rails applications. [![Gem version](https://img.shields.io/gem/v/lookbook)](https://rubygems.org/gems/lookbook) -[![CI status](https://github.com/ViewComponent/lookbook/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ViewComponent/lookbook/actions/workflows/ci.yml) +[![CI status](https://github.com/ViewComponent/lookbook/actions/workflows/ci.yml/badge.svg?branch=v2)](https://github.com/ViewComponent/lookbook/actions/workflows/ci.yml) <br> --- -### 🚀 v2.0 beta now available! +**🚨 This is the v2.0 development branch! 🚨** -Find out what's new and how to test it out on the [v2 beta docs site &rarr;](https://v2.lookbook.build/) +For the current stable release see the [main branch](https://github.com/ViewComponent/lookbook/tree/main). --- -## Documentation +## Resources -✨ **Lookbook guide and API docs**: [lookbook.build](https://lookbook.build) +* 🚧 **Docs**: [v2.lookbook.build](https://v2.lookbook.build) +* 🚧 **Demo**: [v2-demo.lookbook.build/](http://v2-demo.lookbook.build/) ([repo here](https://github.com/ViewComponent/lookbook-demo/tree/v2)) -> _Looking for pre-v1.0 documentation? [Head over here](https://github.com/ViewComponent/lookbook/tree/0.9.x)._ +<br> +[![Lookbook UI](.github/assets/lookbook_ui.png)](http://v2-demo.lookbook.build/) -## Demo -✨ **Online Demo**: [lookbook-demo-app.herokuapp.com/lookbook](https://lookbook-demo-app.herokuapp.com/lookbook) - -✨ **Demo repo**: [github.com/ViewComponent/lookbook-demo](https://github.com/ViewComponent/lookbook-demo) - -[![Lookbook UI](.github/assets/lookbook_screenshot_v1.0_beta.png)](https://lookbook-demo-app.herokuapp.com/lookbook/) - - ## Development -Lookbook is implemented as an isolated [Rails Engine](https://guides.rubyonrails.org/engines.html) and uses [ViewComponent](https://viewcomponent.org), [Tailwind](https://tailwindcss.com/) and [Alpine](https://alpinejs.dev/) for its UI. +Lookbook is implemented as an isolated [Rails Engine](https://guides.rubyonrails.org/engines.html) and uses [ViewComponent](https://viewcomponent.org), [Tailwind](https://tailwindcss.com/) and [Alpine](https://alpinejs.dev/) for it's UI. This repository contains: * The Lookbook source code ([`/app`](https://github.com/ViewComponent/lookbook/tree/main/app), [`/lib`](https://github.com/ViewComponent/lookbook/tree/main/lib), [`/config`](https://github.com/ViewComponent/lookbook/tree/main/config), etc) -* A '[workbench](#workbench)' app used for Lookbook component development ([`/workbench`](https://github.com/ViewComponent/lookbook/tree/main/workbench)). * The Lookbook [documentation site](#docs-site) source code and content ([`/docs`](https://github.com/ViewComponent/lookbook/tree/main/docs)). * A [test suite](#testing) with a 'runable' dummy app ([`/spec`](https://github.com/ViewComponent/lookbook/tree/main/spec)). -### Workbench - -To preview the Lookbook components within a Lookbook instance you can run the included `workbench` app: - -1. Clone this repo -2. Install dependencies: `bundle install & npm install` -3. Start the app: `bin/workbench` -4. Visit http://localhost:4545/lookbook to view the Lookbook instance - -The `workbench` app will be started in development mode and any changes to Lookbook's views or assets will immediately be reflected in the UI. - ### Documentation site The [Lookbook docs site](https://lookbook.build) is built using [Bridgetown](https://www.bridgetownrb.com/) and the source files can be found in the `./docs` directory. To preview changes locally you can run a development version of the docs site: @@ -84,11 +66,11 @@ Lookbook was created by [Mark Perkins](https://github.com/allmarkedup) and continues to grow &amp; improve thanks to the ideas, suggestions and hard work of all of [these excellent humans](https://github.com/ViewComponent/lookbook/graphs/contributors): <br> <br> <a href="https://github.com/ViewComponent/lookbook/graphs/contributors"> - <img alt="Lookbook contributors" src="https://contrib.rocks/image?repo=ViewComponent/lookbook&columns=14" width="800" /> + <img src="https://contrib.rocks/image?repo=ViewComponent/lookbook&columns=14" width="800" /> </a> ## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). \ No newline at end of file