Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated Readme

  • Loading branch information...
commit f5cdfadc23f9cf7670912ebdd519ae87689f1d46 1 parent 7ec8959
Phil LaPier authored
Showing with 29 additions and 26 deletions.
  1. +29 −26 readme.md
55 readme.md
View
@@ -1,18 +1,18 @@
-# Bourbon Sass Mixins
-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.
+![Bourbon Sass Mixin Library](http://thoughtbot.com/bourbon/images/bourbon-logo.png)
+## 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.
+
+#[Read the Documentation](http://thoughtbot.com/bourbon)
# Requirements
Sass 3.1+
-# Documentation
-
-Documentation is available at http://thoughtbot.com/bourbon.
-
# Install for Rails
In your Gemfile:
@@ -23,7 +23,6 @@ Then run:
$ bundle install
## Rails 3.1.x
-
Rename application.css to application.css.scss:
mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss
@@ -98,19 +97,7 @@ Bourbon aims to provide support for CSS3 properties that are not yet fully suppo
*@ denotes a mixin and must be prefaced with @include*
- #Functions
- --------------------------------
- compact(*args)
- modular-scale(*args)
- golden-ratio(*args)
- grid-width(*args)
- flex-grid(*args)
- linear-gradient(*args)
- radial-gradient(*args)
- shade(*args)
- tint(*args)
-
- #Mixins
+ Mixins
--------------------------------
animation
@ animation(*args)
@@ -179,14 +166,28 @@ Bourbon aims to provide support for CSS3 properties that are not yet fully suppo
@ 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
@ hide-text
@ position(*args)
- #{$all-text-inputs}
+ HTML5 Inputs
+ #{$all-text-inputs}
font-family
$georgia
@@ -202,7 +203,6 @@ Bourbon aims to provide support for CSS3 properties that are not yet fully suppo
* = quad, cubic, quart, quint, sine, expo, circ, back
-
## Help Out
Currently the project is a work in progress. Feel free to help out.
@@ -217,6 +217,7 @@ If the answer is yes, there is a high chance the mixin will be accepted via a pu
*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
@@ -224,6 +225,8 @@ Credits
![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+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.
Please sign in to comment.
Something went wrong with that request. Please try again.