Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/bootstrap-sass.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas McDonald <tom@conceptcoding.co.uk>2012-05-14 00:28:06 +0400
committerThomas McDonald <tom@conceptcoding.co.uk>2012-05-14 00:28:06 +0400
commit76ddb93ccf66913c3b8c4d51933daa726705eaf4 (patch)
tree94492a5c9ee9f8afd45598fe1e0853d0056df9bd
parente2c102066a0c32f5db09b3f443529e612be22231 (diff)
restructure readme; add who/projects section
-rw-r--r--README.md30
1 files changed, 22 insertions, 8 deletions
diff --git a/README.md b/README.md
index acc56430..3d3fb2e0 100644
--- a/README.md
+++ b/README.md
@@ -24,13 +24,6 @@ Import "bootstrap" in your SCSS file of choice to get all of Bootstrap's styles,
@import "bootstrap";
-Need to configure a variable or two? Simple define the value of the variable you want to change *before* importing Bootstrap. Sass will respect your existing definition rather than overwriting it with the Bootstrap defaults. A list of customisable variables can be found in the [Bootstrap documentation](http://twitter.github.com/bootstrap/less.html#variables).
-
- $primaryButtonBackground: #f00;
- @import "bootstrap";
-
-**Note**: It's important that the file you are importing is not named `bootstrap`, since this will cause an import loop. As a general rule, errors are something you should try to avoid.
-
#### Javascripts
You can include the Bootstrap javascripts through two methods. In this case, Sprocket's `//= require` directives are useful, since there is no better alternative.
@@ -78,6 +71,27 @@ Install the gem, add the require statement to the top of your configuration file
You'll get the same benefits as those starting from scratch. Radical.
-----
+## Configuration
+Need to configure a variable or two? Simply define the value of the variable you want to change *before* importing Bootstrap. Sass will respect your existing definition rather than overwriting it with the Bootstrap defaults. A list of customisable variables can be found in the [Bootstrap documentation](http://twitter.github.com/bootstrap/less.html#variables).
+
+ $btnPrimaryBackground: #f00;
+ @import "bootstrap";
+
+**Note**: It's important that the file you are importing is not named `bootstrap`, since this will cause an import loop. As a general rule, errors are something you should try to avoid.
+
+### Passing multiple values to mixins
+
+Some CSS3 properties take multiple values, such as `box-shadow` or `text-shadow`. To pass multiple values to the Bootstrap mixins, you must escape the values or else the Sass parser will choke on the commas. Here's how to escape the values in Sass:
+ .selector {
+ @include box-shadow(#{0 2px 5px rgba(0,0,0,.25) inset, 0 -2px 5px rgba(0,0,0,.25) inset});
+ }
+
+### Responsive styling?
As per the Bootstrap project we don't include the responsive styles by default. `@import "bootstrap-responsive";` to get them.
+
+## Who
+bootstrap-sass is a project by [Thomas McDonald](https://twitter.com/#!/thomasmcdonald_), with support from [other awesome people](https://github.com/thomas-mcdonald/bootstrap-sass/graphs/contributors).
+
+## You're in good company
+bootstrap-sass is used to build some awesome projects, including [Diaspora](http://diasporaproject.org/), [rails_admin](https://github.com/sferik/rails_admin), Michael Hartl's [Rails Tutorial](http://railstutorial.org/) and [gitlabhq](http://gitlabhq.com/). Using bootstrap-sass? I'd love it if you let me know through Twitter. \ No newline at end of file