Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.31 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.31 KB
Raw

Rails UI Tailwind CSS Presets

Tailwind CSS presets for Rails UI. These presets are designed to work with the Tailwind CSS framework.

Installation

To install the presets, run the following command in your terminal:

npm install railsui-tailwind-presets

Usage

Once installed, you can import the presets into your Tailwind CSS configuration file (e.g., tailwind.config.js) and use them in your project. Bear in mind, these are designed for exclusive use with Rails UI. Here's an example:

// tailwind.config.js
const presets = require("railsui-tailwind-presets")

module.exports = {
  presets: [presets.hound],
  content: ["./app/**/*.html.erb"],
}

Or just import one preset:

// tailwind.config.js
const { hound } = require("railsui-tailwind-presets")
module.exports = {
  presets: [hound],
  // Other Tailwind CSS configuration options...
}

In this example, we're using the hound preset, which includes the Rails UI styles and a custom primary and secondary color palette. You can choose from the following presets (more coming soon):

  • hound
  • shepherd
  • retriever

License

This project is licensed under the MIT License. See the LICENSE file for more information.