README.md in material-sass-4.0.0.alpha6 vs README.md in material-sass-4.0.0.beta
- old
+ new
@@ -1,21 +1,32 @@
-# Material-sass
+# Material-sass [](http://badge.fury.io/rb/material-sass)
-[](https://gitter.im/mkhairi/material-sass?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+`material-sass` is a rubygems version of Material Design for Bootstrap 4
-`material-sass` is a Sass rubygems version of Material, a HTML5 UI design based on Google Material. Offical repo [github.com/Daemonite/material](https://github.com/Daemonite/material)
+Offical repo [github.com/Daemonite/material](https://github.com/Daemonite/material)
+Documentation [daemonite.github.io/material](http://daemonite.github.io/material)
+
+
+## Dependencies
+
+**Rails 5.1+**
+The Rails JavaScript helpers has been rewritten in a new gem called rails-ujs and they use vanilla JavaScript, so jQuery is not a dependency of Rails anymore.
+Since bootstrap relies on it, install it with ```bin/yarn add jquery``` or via ```gem 'jquery-rails'``` and add ```//= require jquery``` to ```application.js```.
+
+**NOTE:** Ensure that the `sass-rails` gem is presented in your Gemfile.
+
+
+
## Installation
Add this line to your application's Gemfile:
```ruby
+gem 'bootstrap'
gem 'material-sass'
```
-
-**NOTE:** Ensure that the `sass-rails` gem is presented in your Gemfile.
-
And then run the bundler and restart your server to make the files available through the pipeline:
```console
$ bundle install
```
@@ -46,16 +57,33 @@
Require Material javascripts in `app/assets/javascripts/application.js`:
```js
//= require jquery
-//= require material-sprockets
+//= require bootstrap
+//= require material
```
+### c. Icons
+Include this line in the <head>portion of your HTML code
+
+``` <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet"> ```
+
+or import this line in your application.scss
+
+``` @import "https://fonts.googleapis.com/icon?family=Material+Icons"; ```
+
+or install this gem for offline icons
+
+``` gem 'material_icons' ```
+
+see [docs](https://github.com/Angelmmiguel/material_icons)
+
## Contributing
+note: Any changes or Pull Request regarding material assets should be made in official [material](https://github.com/Daemonite/material) repo.
-1. Fork it ( https://github.com/[my-github-username]/material-sass/fork )
+1. Fork it ( https://github.com/mkhairi/material-sass/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request