readme.md in bourbon-1.4.0 vs readme.md in bourbon-2.0.0.rc1
- old
+ new
@@ -1,13 +1,17 @@
-# Bourbon Sass Mixins – [View Documentation](http://thoughtbot.com/bourbon)
-The purpose of Bourbon Sass Mixins is to provide a comprehensive library of Sass
-mixins that are designed to be as vanilla as possible, meaning they should not
-deter you from using the original CSS syntax.
+[](http://thoughtbot.com/bourbon)
+# A simple and lightweight mixin library for Sass
+Bourbon is a comprehensive library of sass mixins that are designed to be simple
+and easy to use. No configuration required. The mixins aim to be as vanilla as
+possible, meaning they should be as close to the original CSS syntax as possible.
+
The mixins contain vendor specific prefixes for all CSS3 properties for support
amongst modern browsers. The prefixes also ensure graceful degradation for older
-browsers that support only CSS3 prefixed properties. Bourbon uses SCSS syntax.
+browsers that support only CSS3 prefixed properties. Bourbon uses SCSS syntax.
+#[Documentation & Demo](http://thoughtbot.com/bourbon)
+
# Requirements
Sass 3.1+
# Install for Rails
In your Gemfile:
@@ -16,14 +20,11 @@
Then run:
$ bundle install
-Bourbon On [RubyGems](https://rubygems.org/gems/bourbon)
-
## Rails 3.1.x
-
Rename application.css to application.css.scss:
mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss
Bourbon needs the sass files to be imported in a specific order to function properly. Therefore, you will need to disable the require\_tree sprocket directive.
@@ -39,13 +40,13 @@
@import "bourbon";
@import "home";
@import "users";
-## Rails 3.0.x and below
-For Rails < 3.1 you must run the installation rake task. Please note, you should run this task every time a new version of Bourbon is released.
-This will copy the Sass files into your project's public/stylesheets/sass directory.
+## Rails 3.0.x
+For Rails 3.0.x you must run the installation rake task. You should run this task every time a new version of Bourbon is released.
+This will copy the Sass files into your project's `public/stylesheets/sass` directory.
rake bourbon:install
Import the mixins at the beginning of your stylesheet
@@ -53,11 +54,11 @@
*Optional*: If you use a non-standard location for your sass files, you can specify the path to your sass files as an argument to the install task
rake bourbon:install[app/stylesheets]
-# Install in a non-rails project (static site, jekyll, wordpress, other...)
+# Rails 2.3 or a non-Rails project (static site, jekyll, wordpress, etc...)
Bourbon includes an easy way to generate a directory with all the necessary files.
Install the bourbon gem:
gem install bourbon
@@ -94,23 +95,12 @@
# All Supported Functions, Mixins, and Addons
[View the Bourbon documentation](http://thoughtbot.com/bourbon)
*@ denotes a mixin and must be prefaced with @include*
- #Functions
+ Mixins
--------------------------------
- compact(*args)
- modular-scale(*args)
- golden-ratio(*args)
- grid-width(*args)
- linear-gradient(*args)
- radial-gradient(*args)
- shade(*args)
- tint(*args)
-
- #Mixins
- --------------------------------
animation
@ animation(*args)
@ animation-delay(*args)
@ animation-direction(*args)
@ animation-duration(*args)
@@ -126,15 +116,15 @@
@ border-image(*args)
border-radius
@ border-radius(*args)
@ border-radius-top(*args)
- @ border-radius-top-left(*args)
- @ border-radius-top-right(*args)
+ @ border-radius-top-left(*args)
+ @ border-radius-top-right(*args)
@ border-radius-bottom(*args)
- @ border-radius-bottom-left(*args)
- @ border-radius-bottom-right(*args)
+ @ border-radius-bottom-left(*args)
+ @ border-radius-bottom-right(*args)
@ border-radius-left(*args)
@ border-radius-right(*args)
@ box-shadow(*args)
@ box-sizing(*args)
@@ -143,13 +133,13 @@
@columns(*args)
@column-count(*args)
@column-fill(*args)
@column-gap(*args)
@column-rule(*args)
- @column-rule-color(*args)
- @column-rule-style(*args)
- @column-rule-width(*args)
+ @column-rule-color(*args)
+ @column-rule-style(*args)
+ @column-rule-width(*args)
@column-span(*args)
@column-width(*args)
flex-box
@ box(*args)
@@ -164,27 +154,43 @@
@ display-box
@ inline-block
@ linear-gradient(*args)
@ radial-gradient(*args)
- @ transform(*args)
- @ transform-origin(*args)
+ transform
+ @ transform(*args)
+ @ transform-origin(*args)
+
transition
@ transition(*args)
@ transition-delay(*args)
@ transition-duration(*args)
@ transition-property(*args)
@ transition-timing-function(*args)
- #Addons
+ @ user-select
+
+ Functions
--------------------------------
+ compact(*args)
+ flex-grid(*args)
+ golden-ratio(*args)
+ grid-width(*args)
+ linear-gradient(*args)
+ radial-gradient(*args)
+ shade(*args)
+ tint(*args)
+
+ Addons
+ -------------------------------
@ button(*args)
@ clearfix
- @ position(*args)
+ @ hide-text
- #{$all-text-inputs}
+ HTML5 Inputs
+ #{$all-text-inputs}
font-family
$georgia
$helvetica
$lucida-grande
@@ -196,11 +202,10 @@
$ease-out-*
$ease-in-out-*
* = quad, cubic, quart, quint, sine, expo, circ, back
-
## Help Out
Currently the project is a work in progress. Feel free to help out.
A general rule when considering filing a pull request for a new mixin: Do the following browsers *only* support the CSS3 property using vendor specific prefixes?
If the answer is yes, there is a high chance the mixin will be accepted via a pull request.
@@ -211,15 +216,18 @@
* Opera 10+
* IE 9+
*Bourbon does not intend to support IE filters.*
+
Resources for checking browser support: [MDN - Moz Dev Network](https://developer.mozilla.org/en-US/), [Mozilla CSS Extensions](https://developer.mozilla.org/en/CSS_Reference/Mozilla_Extensions), [Webkit CSS Properties](http://css-infos.net/properties/webkit.php), [Firefox CSS Properties](http://css-infos.net/properties/firefox.php), [MSDN - Microsoft Dev Network](http://msdn.microsoft.com/en-us/library/ms531207(v=VS.85).aspx)
Credits
-------
+
+Got questions? Need help? Tweet at [@phillapier](http://twitter.com/phillapier).
Bourbon is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
The names and logos for thoughtbot are trademarks of thoughtbot, inc.