README.md in lookbook-1.2.1 vs README.md in lookbook-1.3.0
- old
+ new
@@ -1,53 +1,86 @@
-# Lookbook
-
-<div>
-<a href="https://rubygems.org/gems/lookbook"><img src="https://img.shields.io/gem/v/lookbook" alt="Gem version"></a>
-<a href="https://github.com/allmarkedup/lookbook/actions/workflows/ci.yml"><img src="https://github.com/allmarkedup/lookbook/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI status"></a>
-</div>
<br>
+<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.
+[](https://rubygems.org/gems/lookbook)
+[](https://github.com/allmarkedup/lookbook/actions/workflows/ci.yml)
+<br>
+
## Documentation
-**Lookbook (v1.x)** documentation: **[https://lookbook.build](https://lookbook.build)**
+✨ **Lookbook guide and API docs**: [lookbook.build](https://lookbook.build)
-> _Looking for v0.9.x docs? [Head over here](https://github.com/allmarkedup/lookbook/tree/0.9.x)._
+> _Looking for pre-v1.0 documentation? [Head over here](https://github.com/allmarkedup/lookbook/tree/0.9.x)._
## Demo
-**Online Demo:** [https://lookbook-demo-app.herokuapp.com/lookbook](https://lookbook-demo-app.herokuapp.com/lookbook)
+✨ **Online Demo**: [lookbook-demo-app.herokuapp.com/lookbook](https://lookbook-demo-app.herokuapp.com/lookbook)
+✨ **Demo repo**: [github.com/allmarkedup/lookbook-demo](https://github.com/allmarkedup/lookbook-demo)
+
[](https://lookbook-demo-app.herokuapp.com/lookbook/)
## Development
-Lookbook's UI is itself built using ViewComponents. To preview these components in a Lookbook instance you can run the included `workbench` app:
+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/allmarkedup/lookbook/tree/main/app), [`/lib`](https://github.com/allmarkedup/lookbook/tree/main/lib), [`/config`](https://github.com/allmarkedup/lookbook/tree/main/config), etc)
+* A '[workbench](#workbench)' app used for Lookbook component development ([`/workbench`](https://github.com/allmarkedup/lookbook/tree/main/workbench)).
+* The Lookbook [documentation site](#docs-site) source code and content ([`/docs`](https://github.com/allmarkedup/lookbook/tree/main/docs)).
+* A [test suite](#testing) with a 'runable' dummy app ([`/spec`](https://github.com/allmarkedup/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.
-### Docs site
+### 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 see a local version of the site run `bin/docs` from the root of this repo and then visit http://localhost:4000 in your browser.
+To preview changes locally you can run a development version of the docs site:
+1. Clone this repo
+2. Install dependencies: `bundle install`
+3. Start the app: `bin/docs`
+4. Visit http://localhost:4000
+
### Testing
-Lookbook uses RSpec for testing.
+Lookbook uses [RSpec](https://relishapp.com/rspec) for testing.
Tests can be run using the `rake spec` or `bundle exec rspec` commands.
The dummy app that the tests are being run against can be viewed by running the `bin/dummy` command and then browsing to http://localhost:9292/lookbook
+## Contributing
+
+Lookbook is an un-funded open source project and contributions of all types and sizes are most welcome!
+
+Please take the time to read over the [Contributing](./CONTRIBUTING.md) guide before making your first contribution and if anything isn't clear then [start a discussion](https://github.com/allmarkedup/lookbook/discussions) and we will do our best to help you out.
+
+## Contributors
+
+Lookbook was created by [Mark Perkins](https://github.com/allmarkedup) and continues to grow
+& improve thanks to the ideas, suggestions and hard work of all of [these excellent humans](https://github.com/allmarkedup/lookbook/graphs/contributors):
+<br>
+<br>
+<a href="https://github.com/allmarkedup/lookbook/graphs/contributors">
+ <img src="https://contrib.rocks/image?repo=allmarkedup/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