README.md in furatto-1.4.0 vs README.md in furatto-1.5.0

- old
+ new

@@ -1,32 +1,24 @@ # Furatto for Rails Asset Pipeline Furatto is a lightweight & friendly front-end framework got get the job done, created and maintained by [Abraham Kuri](https://twitter.com/kurenn) from [Icalia Labs](http://twitter.com/icalialabs). -The furatto gem integrates the Furatto CSS framework for Rails 3.1+ Asset Pipeline. +The furatto gem integrates the Furatto CSS framework for Rails 4+ Asset Pipeline. ## Table of contents - [Installing Gem](#installing-gem) -- [Using Rails 4?](#using-rails-4?) +- [Issues](#issues) - [Contributors & Patches & Forks](#contributors-&-patches-&-forks) - [Furatto heroe](#furatto-heroe) - [Credits](#credits) - [License](#license) ## Installing Gem -**Because furatto uses [Compass](http://compass-style.org/reference/compass/css3/), you need to add the compass-rails gem into the assets group from your Gemfile.** +You need to only include the `furatto` gem inside your `Gemfile`: ```ruby -group :assets do - gem 'compass-rails' -end -``` - -After including the compass-rails gem, you need to add the furatto gem to your application's Gemfile: - -```ruby gem 'furatto' ``` or you can install from the latest build: @@ -38,53 +30,41 @@ ```console $ bundle ``` -## Add furatto to the asset pipeline +After running the `bundle` command, the gem now comes with an installer for easy setup. -Add to your `app/assets/stylesheets/application.css` - - *= require normalize - *= require furatto +```console +$ rails g furatto:install +``` -Add to your `app/assets/javascripts/application.js` +This will add furatto to the asset pipeline automatically, and install an application layout skeleton. - //= require furatto - -## Using Rails 4? +Now you can just run the rails server and then everything should be nice and clean. -The configuration for Rails 4 is pretty similar. +## Issues -```ruby -gem 'compass-rails', '~> 1.1.3' -``` +If for some reason you find troubles installing the gem due to `sass` version like: -After including the compass-rails gem, you need to add the furatto gem to your application's Gemfile: - ```ruby -gem 'furatto' -``` +Bundler could not find compatible versions for gem "sass-rails": + In snapshot (Gemfile.lock): + sass-rails (= 5.0.3) -or you can install from the latest build: + In Gemfile: + furatto (>= 0) ruby depends on + compass-rails (>= 2.0.4, ~> 2.0) ruby depends on + sass-rails (<= 5.0.1) ruby -```ruby -gem 'furatto', git: 'git@github.com:IcaliaLabs/furatto-rails.git' -``` + sass-rails (~> 5.0) ruby -Install the gem using the bundle command: - -```console -$ bundle +Running `bundle update` will rebuild your snapshot from scratch, using only +the gems in your Gemfile, which may resolve the conflict. ``` -After running the `bundle` command, the gem now comes with an installer for easy setup. +Just remove the `Gemfile.lock` from the project or update the `sass-rails` gem. -```console -$ rails g furatto:install -``` - -This will add furatto to the asset pipeline automatically, and install an application layout skeleton. ## Contributors & Patches & Forks - Abraham Kuri Vargas ([@kurenn](http://twitter.com/kurenn))