Skip to content
This repository
Browse code

Updated Readme

  • Loading branch information...
commit f5cdfadc23f9cf7670912ebdd519ae87689f1d46 1 parent 7ec8959
authored March 16, 2012

Showing 1 changed file with 29 additions and 26 deletions. Show diff stats Hide diff stats

  1. 55  readme.md
55  readme.md
Source Rendered
... ...
@@ -1,18 +1,18 @@
1  
-# Bourbon Sass Mixins
2  
-The purpose of Bourbon Sass Mixins is to provide a comprehensive library of Sass
3  
-mixins that are designed to be as vanilla as possible, meaning they should not
4  
-deter you from using the original CSS syntax.
  1
+![Bourbon Sass Mixin Library](http://thoughtbot.com/bourbon/images/bourbon-logo.png)
  2
+## A simple and lightweight mixin library for Sass.
  3
+Bourbon is a comprehensive library of sass mixins that are designed to be simple
  4
+and easy to use. No configuration required. The mixins aim to be as vanilla as
  5
+possible, meaning they should be as close to the original CSS syntax as possible.
  6
+
5 7
 The mixins contain vendor specific prefixes for all CSS3 properties for support
6 8
 amongst modern browsers. The prefixes also ensure graceful degradation for older
7  
-browsers that support only CSS3 prefixed properties.  Bourbon uses SCSS syntax.
  9
+browsers that support only CSS3 prefixed properties. Bourbon uses SCSS syntax.
  10
+
  11
+#[Read the Documentation](http://thoughtbot.com/bourbon)
8 12
 
9 13
 # Requirements
10 14
 Sass 3.1+
11 15
 
12  
-# Documentation
13  
-
14  
-Documentation is available at http://thoughtbot.com/bourbon.
15  
-
16 16
 # Install for Rails
17 17
 In your Gemfile:
18 18
 
@@ -23,7 +23,6 @@ Then run:
23 23
     $ bundle install
24 24
 
25 25
 ## Rails 3.1.x
26  
-
27 26
 Rename application.css to application.css.scss:
28 27
 
29 28
     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
98 97
 
99 98
 *@ denotes a mixin and must be prefaced with @include*
100 99
 
101  
-    #Functions
102  
-    --------------------------------
103  
-      compact(*args)
104  
-      modular-scale(*args)
105  
-      golden-ratio(*args)
106  
-      grid-width(*args)
107  
-      flex-grid(*args)
108  
-      linear-gradient(*args)
109  
-      radial-gradient(*args)
110  
-      shade(*args)
111  
-      tint(*args)
112  
-
113  
-    #Mixins
  100
+    Mixins
114 101
     --------------------------------
115 102
       animation
116 103
         @ animation(*args)
@@ -179,14 +166,28 @@ Bourbon aims to provide support for CSS3 properties that are not yet fully suppo
179 166
         @ transition-property(*args)
180 167
         @ transition-timing-function(*args)
181 168
 
182  
-    #Addons
  169
+      @ user-select
  170
+
  171
+    Functions
183 172
     --------------------------------
  173
+      compact(*args)
  174
+      flex-grid(*args)
  175
+      golden-ratio(*args)
  176
+      grid-width(*args)
  177
+      linear-gradient(*args)
  178
+      radial-gradient(*args)
  179
+      shade(*args)
  180
+      tint(*args)
  181
+
  182
+    Addons
  183
+    -------------------------------
184 184
       @ button(*args)
185 185
       @ clearfix
186 186
       @ hide-text
187 187
       @ position(*args)
188 188
 
189  
-      #{$all-text-inputs}
  189
+      HTML5 Inputs
  190
+        #{$all-text-inputs}
190 191
 
191 192
       font-family
192 193
         $georgia
@@ -202,7 +203,6 @@ Bourbon aims to provide support for CSS3 properties that are not yet fully suppo
202 203
         * = quad, cubic, quart, quint, sine, expo, circ, back
203 204
 
204 205
 
205  
-
206 206
 ## Help Out
207 207
 
208 208
 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
217 217
 
218 218
 *Bourbon does not intend to support IE filters.*
219 219
 
  220
+
220 221
 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)
221 222
 
222 223
 Credits
@@ -224,6 +225,8 @@ Credits
224 225
 
225 226
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
226 227
 
  228
+Got questions? Need help? Tweet at [@phillapier](http://twitter.com/phillapier).
  229
+
227 230
 Bourbon is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
228 231
 
229 232
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.

0 notes on commit f5cdfad

Please sign in to comment.
Something went wrong with that request. Please try again.