README.md in boarding_pass-0.1.9 vs README.md in boarding_pass-1.0.0.beta1

- old
+ new

@@ -1,27 +1,90 @@ # Boarding Pass -Boarding Pass provides a set of tools and defaults to quickly start web project front-ends. Includes [Sass](http://sass-lang.com/), [Bourbon](http://bourbon.io/), and [Neat](http://neat.bourbon.io/). +Default styles for websites using [Sass](http://sass-lang.com/). Compatible with both the original Ruby Sass and [node-sass](https://github.com/andrew/node-sass). Includes [Bourbon](http://bourbon.io/), [Neat](http://neat.bourbon.io/), [Typeplate](http://typeplate.com), and [Colors](http://clrs.cc). ## Installation -Add this line to your application's Gemfile: +### node-sass - gem 'boarding_pass' +```shell +npm install boarding-pass +``` -And then execute: +Require the boarding-pass module and set Boarding Pass' `includePaths` property to node-sass' `includePaths` option. - bundle install +```javascript +var sass = require('node-sass'); +var boardingPass = require('boarding-pass'); +sass.render({ + file: scss_filename, + success: callback, + includePaths: boardingPass.includePaths, +}); +``` + +This will load the paths for Boarding Pass, Bourbon, and Neat. + +In your scss file, simply add: + +```scss +@import "boarding_pass"; +``` + ### Rails 3.1+ +Add to your `Gemfile`: + +```ruby +gem 'boarding_pass' +``` + +Run: + +```shell +bundle install +``` + In your `application.css.scss` file, add: - @import "boarding_pass"; +```scss +@import "boarding_pass"; +``` -## Todo -* Add generators for non-Rails/Middleman projects. +## Colors +The variable names from the Colors library have been changed slightly to include a prefix of `$default-`: + +```scss +// Cool +$default-aqua: #7fdbff; +$default-blue: #0074d9; +$default-navy: #001f3f; +$default-teal: #39cccc; +$default-green: #2ecc40; +$default-olive: #3d9970; +$default-lime: #01ff70; + +// Warm +$default-yellow: #ffdc00; +$default-orange: #ff851b; +$default-red: #ff4136; +$default-fuchsia: #f012be; +$default-purple: #b10dc9; +$default-maroon: #85144b; + +// Gray Scale +$default-white: #fff; +$default-silver: #ddd; +$default-gray: #aaa; +$default-black: #111; +``` + +## Contributing +Clone and run `npm install`. + +You can run a local preview server to view your changes with `node server.js`. Any changes will be recompiled on page refresh. ## License Copyright © 2013 LaCroix Design Co. Released under the MIT License