chameleon-sass - npm Package Compare versions

Comparing version 0.0.1 to 0.0.3

bower.json

 {
   "name": "chameleon-sass",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "homepage": "https://github.com/djgrant/chameleon",
@@ -5,0 +5,0 @@ "authors": [

package.json

 {
   "name": "chameleon-sass",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "A styleless Sass framework for responsive user interfaces",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -5,10 +5,11 @@ Chameleon
 
-### Getting started
+## Getting started
 
-From the command line:
+### Installing in a Rails project
 
-`gem install sass-chameleon`
+Add to your Gemfile:
 
+`gem 'chameleon-sass'`
 
-In your Sass project:
+Add to your main Sass stylesheet:
 
@@ -18,4 +19,40 @@ `@import "chameleon";`
 
-Generate some responsive grid classes:
+### Installing in a Compass project
 
+From the command line:
+
+`gem install chameleon-sass`
+
+Add to the top of your Compass config file (usually config.rb):
+
+`require 'chameleon-sass'`
+
+Add to your main Sass stylesheet:
+
+`@import "chameleon"`
+
+
+### Installing in a Bower project
+
+From the command line:
+
+`bower install chameleon-sass`
+
+If you are using Compass you can add the import path to your Compass config file (usually config.rb):
+
+`add_import_path "bower_components/chameleon-sass/assets/stylesheets/"`
+
+Otherwise, you will need to manually add the above path to your @import.
+
+Add to your main Sass stylesheet:
+
+`@import "chameleon"`
+
+
+### Generating a responsive grid
+
+One of the defining feature of Chameleon is that no CSS is generated until you explictly declare the generation of some classes.
+
+Let's get started by adding some building blocks of a responsive grid:
+
 ```
@@ -22,0 +59,0 @@ @include grid-defaults();

No alert changes

Improved metrics

Lines of code

71

increased by4.41%

Number of lines in readme file

61

increased by154.17%

Worsened metrics

Total package byte prevSize

3949

decreased by-47.32%

No dependency changes