Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
allmarkedup committed May 18, 2024
1 parent c509338 commit 52e71a0
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

This branch contains a work-in-progress, exploratory, from-scratch rebuild of Lookbook, intended to form the basis of a future v3.0 release.

[Usage](#usage)[Development](#development)[Background & motivation](#v3-rebuild---background-and-motivation)[Current status](#v3-rebuild---current-status)[Requirements](#requirements)
[Demo](#demo-site)[Usage](#usage)[Development](#development)[Background & motivation](#v3-rebuild---background-and-motivation)[Current status](#v3-rebuild---current-status)

![CI status](https://github.com/ViewComponent/lookbook/actions/workflows/ci.yml/badge.svg?branch=v3)

## Demo site

Expand All @@ -22,6 +24,11 @@ However, intrepid individuals who are familiar with Lookbook and wish to kick th

> Alternatively you can pull down the codebase and [run the included demo app](#demo-app) to see some of the new features in action.
### Requirements

* Ruby >= 3.0.0
* Rails >= 6.1.0

### Installation

Add Lookbook to the `development` group in your Gemfile:
Expand Down Expand Up @@ -325,11 +332,6 @@ The 'todo' list below is intended to provide a _very rough_ overview of the curr
* [ ] Automate API docs via YARD
* [ ] Set up automated build & deploy process for docs

## Requirements

* Ruby >= 3.0.0
* Rails >= 6.1.0

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit 52e71a0

Please sign in to comment.