README.md in simple_form-theme-0.1.0 vs README.md in simple_form-theme-0.1.1

- old
+ new

@@ -1,28 +1,53 @@ # SimpleForm::Theme Short description and motivation. -## Usage -How to use my plugin. +### Supported CSS Frameworks +* [Tailwind CSS](https://tailwindcss.com/docs/installation) +* [Bulma](https://bulma.io/documentation/start/installation) ## Installation Add this line to your application's Gemfile: ```ruby gem 'simple_form-theme' ``` And then execute: ```bash -$ bundle +bundle ``` -Or install it yourself as: +As an alternative instead of adding an additional dependency to your project, +you can copy the initializer file to your project from the GitHub repository. + +Example: ```bash -$ gem install simple_form-theme +cp lib/generators/simple_form/theme/templates/config/initializers/simple_form_tailwindcss.rb yourapp/config/initializers/simple_form_tailwindcss.rb ``` +However, if you install the gem, you will get the latest updates and improvements. + +## Requirements + +* Make sure you have installed [simple_form](https://github.com/heartcombo/simple_form) gem. +* Make sure you have installed the decired css framework. + +## Usage + +### Install Tailwind CSS initializer + +```bash +bin/rails generate simple_form:theme:tailwind install +``` + +### Install Bulma CSS initializer + +```bash +bin/rails generate simple_form:theme:bulma install +``` + ## Contributing -Contribution directions go here. +Bug reports and pull requests are welcome on GitHub at https://github.com/JuanVqz/simple_form-theme ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).