Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ineedjet committed Nov 26, 2024
1 parent 3eb948e commit 368881b
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Catabler
Short description and motivation.

## Usage
How to use my plugin.
[Tabler](https://tabler.io/) ruby gem for Ruby on Rails 8

## Installation
Add this line to your application's Gemfile:
Expand All @@ -11,18 +8,20 @@ Add this line to your application's Gemfile:
gem "catabler"
```

And then execute:
```bash
$ bundle
And css to application.css
```css
@import url("./tabler.min.css");
```

Or install it yourself as:
```bash
$ gem install catabler
Pin in importmap.rb
```ruby
pin "tabler", to: "tabler.esm.min.js"
```

## Contributing
Contribution directions go here.
Import in application.js
```ruby
import "tabler"
```

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

0 comments on commit 368881b

Please sign in to comment.