README.md in bitters-0.10.0 vs README.md in bitters-0.10.1
- old
+ new
@@ -1,99 +1,118 @@
-Bitters
-===
-Scaffold styles, variables and structure for [Bourbon](http://bourbon.io) projects.
+# Bitters
-Bitters is meant to help designers start projects faster by defining a basic set of variables and project structure. After you have Bitters installed, jump in and start customizing the styles and variables to your design and brand requirements.
+[](https://rubygems.org/gems/bitters)
-Bitters should live in your project's sass root folder and be **modified** and extended while you design your project.
+***
-Install Instructions
-===
-Install Bitters:
+## Scaffold styles, variables and structure for [Bourbon](http://bourbon.io) projects.
-```bash
-gem install bitters
-```
+Bitters helps designers start projects faster by defining a basic set of Sass variables, default element style and project structure. It’s been specifically designed for use within web applications. Bitters should live in your project’s root Sass directory and we *encourage* you to modify and extend it to meet your design and brand requirements.
-Install [Bourbon](https://github.com/thoughtbot/bourbon#install-for-rails-31) (required) and [Neat](https://github.com/thoughtbot/neat#install-instructions) (optional).
+Bitters is made to work alongside a CSS reset and not replace it. Our suggested reset is [Normalize](http://necolas.github.io/normalize.css).
-Then `cd` to your Sass directory and run:
+## Requirements
-```bash
-bitters install
-```
+- [Sass](https://github.com/sass/sass) 3.0+
+- [Bourbon](https://github.com/thoughtbot/bourbon) 2.0+
+- Ruby 1.9.3+ (required to install Bitters from the command line)
-A `base` directory will be generated which contains all of the Bitters files.
+## Installation
-Import Bitters after Bourbon in your `application.css.scss` or main manifest file. All additional stylesheets should be imported below Bitters.
+Bitters uses the [RubyGems](https://rubygems.org) package manager to easily generate a `base` directory with all of the necessary files.
-When using Neat, have the following line in `_base.scss` uncommented:
+For command line help, use `bitters help` or visit the [Command Line Interface Wiki](https://github.com/thoughtbot/bitters/wiki/Command-Line-Interface).
-```scss
-@import 'grid-settings';
-```
+1. Install the Bitters gem:
-If you are using Neat, import it after Bitters.
+ ```bash
+ gem install bitters
+ ```
-```scss
-@import 'bourbon';
-@import 'base/base';
-@import 'neat';
+ *If you use [rbenv](https://github.com/sstephenson/rbenv), be sure to run `rbenv rehash` without any errors.*
-// All other imports
-```
+2. Install [Bourbon](https://github.com/thoughtbot/bourbon#installation) (required) and [Neat](https://github.com/thoughtbot/neat#installation) (optional).
-If you want to use Neat functions in Bitters files you can `@import 'grid-settings';` before Neat, remove `@import 'grid-settings';` from `_base.scss` and import the rest of bitters after. eg:
+3. Install the Bitters library into the current directory:
-```scss
-@import 'bourbon';
-@import 'base/grid-settings';
-@import 'neat';
-@import 'base/base';
+ ```bash
+ bitters install
+ ```
-// All other imports
-```
-We suggest using [Normalize](http://necolas.github.io/normalize.css/) for a CSS reset with Bitters.
+ A `base` directory will be generated which contains all of the Bitters files.
-Getting Started
-===
+4. Import Bitters after Bourbon in your `application.css.scss` or main manifest file. All additional stylesheets should be imported below Bitters.
+ ```bash
+ @import "bourbon";
+ @import "base/base";
+ ```
+
+5. When using Neat, uncomment the following line in `_base.scss`:
+
+ ```scss
+ @import "grid-settings";
+ ```
+
+ And import Neat after Bitters:
+
+ ```scss
+ @import "bourbon";
+ @import "base/base";
+ @import "neat";
+
+ // All other imports
+ ```
+
+ If you want to use Neat functions in Bitters, you can `@import "grid-settings";` before Neat, remove `@import "grid-settings";` from `_base.scss` and import the rest of bitters after. For example:
+
+ ```scss
+ @import "bourbon";
+ @import "base/grid-settings";
+ @import "neat";
+ @import "base/base";
+
+ // All other imports
+ ```
+
+## Using Bitters
+
### Sass structure & default style
-The Bitters folder should contain styles for all the basic elements used throughout the project. It also contains folders for custom mixins and extends for your site as well. Add code to the existing files or add new files to the folders. Customize Bitters for your site as you see fit.
+The Bitters directory should contain styles for all the basic elements used throughout the project. It also contains directories for custom mixins and extends for your site as well. Add code to the existing files or add new files to the directories. Customize Bitters for your site as you see fit.
### Variables
-This houses all variables that are used, or will be used, in more than one file in your site. Variable names in Bitters that are used outside of the variables file start with $base to indicate that they are the most basic variables.
+This houses all variables that are used, or will be used, in more than one file in your site. Variable names in Bitters that are used outside of the variables file start with `$base` to indicate that they are the most basic variables.
### Grid settings
-Variables specifically created for Neat resets and breakpoints. To be used, these need to be imported separately from the rest of your base file above Neat in your main stylesheet. Otherwise just remove the file.
+Variables specifically created for [Neat](http://neat.bourbon.io) resets and breakpoints. To be used, these need to be imported separately from the rest of your base file above Neat in your main stylesheet. Otherwise just remove the file.
### Typography
All type is based on `$base-font-size` which is set to 1em (16px) by default. The spacing around type is based on `$base-line-height` so as to keep a semi-baseline grid. All sizes are scaled up or down by a factor of `.25`.
### Lists
-All lists have stripped out styles. No bullets, no left padding. To add back the expected browser default styles add `@extend %default-ul;` or `@extend %default-ol;` to the `<ul>` or `<ol>` respectively..
+All lists have stripped out styles. No bullets, no left padding. To add back the expected browser default styles add `@extend %default-ul;` or `@extend %default-ol;` to the `<ul>` or `<ol>` respectively.
### Forms
Adds basic styles all form elements. The variables at the top of the file all inherit from the variables file but make it really easy to be overridden.
### Buttons
Basic style for `button` and `input[type="submit"]`. Button style can be changed by setting the `$button-style` variable to one of the [Bourbon](http://bourbon.io) button style [options](http://bourbon.io/docs/#buttons).
### Flashes
-Used for any error, warning or success messages in applications or forms. Specifically made for rails application notices.
+Used for any error, warning or success messages in applications or forms. Specifically made for [Ruby on Rails](http://rubyonrails.org) application notices.
-Requirements
-===
-- Sass 3.0+
-- Bourbon 2.0+
+## The Bourbon family
-Credits
-===
+- [Bourbon](http://bourbon.io): A simple and lightweight mixin library for Sass
+- [Neat](http://neat.bourbon.io): A lightweight semantic grid framework for Sass and Bourbon
+- [Bitters](http://bitters.bourbon.io): Scaffold styles, variables and structure for Bourbon projects
+- [Refills](http://refills.bourbon.io): Prepackaged patterns and components, built on top of Bourbon, Bitters & Neat
+## Credits
+
-Bitters is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community). Tweet your questions or suggestions at [@kylefiedler](https://twitter.com/kylefiedler).
+Bitters is maintained and funded by [thoughtbot, inc](http://thoughtbot.com). Tweet your questions or suggestions to [@bourbonsass](https://twitter.com/bourbonsass) and while you’re at it follow us too.
-License
-===
+## License
-Bitters is Copyright © 2014 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+Copyright © 2013–2014 [thoughtbot, inc](http://thoughtbot.com). Bitters is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).