Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mkhairi committed Jan 30, 2018
1 parent 8199079 commit f733110
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,18 @@ gem 'bootstrap'
gem 'bootswatch'
```

Bootstrap JavaScript depends on jQuery. If you're using Rails 5.1+, add the jquery-rails gem to your Gemfile:
```ruby
gem 'jquery-rails'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install bootswatch

## Usage

in your application.css.scss
### Stylesheets
in your ```application.scss```
```scss
// example override bootswatch variables
$primary: #FFCF06;
Expand All @@ -40,6 +41,24 @@ $dark: #444444;
@import "bootswatch/materia/bootswatch";
```

Make sure the file has .scss extension (or .sass for Sass syntax). If you have just generated a new Rails app, it may come with a .css file instead. If this file exists, it will be served instead of Sass, so rename it:


### Javascript
Add Bootstrap dependencies and Bootstrap to your ```application.js```:
```js
//= require jquery3
//= require popper
//= require bootstrap
```
or use individual Bootstrap components for ease of debugging
```js
//= require jquery3
//= require popper
//= require bootstrap-sprockets
```
see more on bootstrap [readme](https://github.com/twbs/bootstrap-rubygem)

## Contributing

1. Fork it ( https://github.com/mkhairi/bootswatch/fork )
Expand Down

0 comments on commit f733110

Please sign in to comment.