Skip to content

Commit

Permalink
Adds info about merging to README
Browse files Browse the repository at this point in the history
  • Loading branch information
nolantait committed Sep 4, 2024
1 parent f191aa2 commit ca91d04
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 @@ -268,9 +268,11 @@ end
`css[:container]` slot which we define in our theme. The `ul` elements class
would be `space-y-4` as that is the `css[:container]` on our theme.

Special html options will be safely merged. For examples, the component above
defines a list controller. If we passed our own controller into data when we
initialize, the component's data-controller attribute would be appended to:
Special html options (`class`, `data`) will be safely merged.

For examples, the component above defines a list controller. If we passed our
own controller into data when we initialize, the component's data-controller
attribute would be appended to:

```ruby
render List.new(
Expand Down Expand Up @@ -317,7 +319,7 @@ class List < Protos::Component
end
```

This makes our initializaiton declarative and easy to extend without having to
This makes our initialization declarative and easy to extend without having to
consider how to call `super` in the initializer.

The following keywords are reserved in the base class:
Expand Down Expand Up @@ -401,15 +403,15 @@ If bundler is not being used to manage dependencies, install the gem by executin

## Usage

Setup [Tailwindcss](https://tailwindcss.com/), [daisyUI](https://daisyui.com)
Setup [TailwindCSS](https://tailwindcss.com/), [DaisyUI](https://daisyui.com)
and add the protos path to your content.

```
npm install -D tailwindcss postcss autoprefixer daisyui
npx tailwindcss init
```

Then we need to add the protos path to the `content` of our tailwindcss config
Then we need to add the protos path to the `content` of our tailwind config
so tailwind will read the styles defined in the Protos gem.

Protos also uses semantic spacing such as `p-sm` or `m-md` instead of set
Expand Down

0 comments on commit ca91d04

Please sign in to comment.