Skip to content

Tweak install instructions #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koppen merged 3 commits into from
Nov 7, 2025
Merged

Tweak install instructions #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
012ec27
Prefer double quotes
koppen Nov 7, 2025
d6bdae0
Assume yarn
koppen Nov 7, 2025
d8fcd0e
Clarify that tailwindcss-rails is not optional
koppen Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Flowbite Components provides a comprehensive library of UI components following
Add the gem to your application's Gemfile:

```ruby
gem 'flowbite-components'
gem "flowbite-components"
```

Then execute:
Expand All @@ -31,9 +31,9 @@ Then execute:
bundle install
```

### Configuration
### tailwindcss-rails

Make sure you have Tailwind CSS installed in your Rails application. We recommend using the [tailwindcss-rails](https://github.com/rails/tailwindcss-rails) gem:
Tailwind needs to be able to look through your code in order to generate the final CSS file with the class names you actually use. To allow Tailwind to find CSS class names inside flowbite-components you need to use [tailwindcss-rails](https://github.com/rails/tailwindcss-rails) gem:

```ruby
gem "tailwindcss-rails", ">= 4.3.0"
Expand All @@ -44,7 +44,7 @@ gem "tailwindcss-rails", ">= 4.3.0"
Install Flowbite as an npm dependency:

```bash
npm install flowbite
yarn add flowbite
```

Add Flowbite to your Tailwind CSS configuration. In your `app/assets/tailwind/application.css`:
Expand Down