Skip to content
Browse files

update readme files to 2.0.4

  • Loading branch information...
1 parent 07cc4d1 commit 8dcea1148b21554f9d2e20ae013719894edbd438 @m5o m5o committed May 17, 2012
Showing with 38 additions and 20 deletions.
  1. +33 −15 README.md
  2. +5 −5 js/README.md
View
48 README.md
@@ -1,31 +1,41 @@
-TWITTER BOOTSTRAP
+[Twitter Bootstrap](http://twitter.github.com/bootstrap) [![Build Status](https://secure.travis-ci.org/twitter/bootstrap.png)](http://travis-ci.org/twitter/bootstrap)
=================
-Bootstrap is Twitter's toolkit for kickstarting CSS for websites, apps, and more. It includes base CSS styles for typography, forms, buttons, tables, grids, navigation, alerts, and more.
+Bootstrap provides simple and flexible HTML, CSS, and Javascript for popular user interface components and interactions. In other words, it's a front-end toolkit for faster, more beautiful web development. It's created and maintained by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat) at Twitter.
-To get started -- checkout http://twitter.github.com/bootstrap!
+To get started, checkout http://twitter.github.com/bootstrap!
-Usage
------
+
+Quick start
+-----------
+
+Clone the repo, `git clone git@github.com:twitter/bootstrap.git`, or [download the latest release](https://github.com/twitter/bootstrap/zipball/master).
+
+
+
+SASS: Usage
+-----------
You can use the SASS Twitter Bootstrap by dropping the compiled CSS into any new project and start cranking.
Because SASS always outputs standard css, just link to the final output like normal:
- <link rel="stylesheet" type="text/css" href="bootstrap-2.0.3.css">
+`<link rel="stylesheet" type="text/css" href="bootstrap-2.0.3.css">`
For more info, refer to the docs!
-Basic modification
-------------------
+
+SASS: Basic modification
+------------------------
You can learn more about SASS at:
- http://sass-lang.com
+[sass-lang.com](http://sass-lang.com)
+
+SASS runs as a local GEM on your system. You can run `sass --watch lib/bootstrap.scss:bootstrap-2.0.3.css`
-SASS runs as a local GEM on your system. You can run "sass --watch lib/bootstrap.scss:bootstrap-2.0.3.css"
Versioning
@@ -39,13 +49,14 @@ Releases will be numbered with the follow format:
And constructed with the following guidelines:
-* Breaking backward compatibility bumps the major
-* New additions without breaking backward compatibility bumps the minor
-* Bug fixes and misc changes bump the patch
+* Breaking backward compatibility bumps the major (and resets the minor and patch)
+* New additions without breaking backward compatibility bumps the minor (and resets the patch)
+* Bug fixes and misc changes bumps the patch
For more information on SemVer, please visit http://semver.org/.
+
Bug tracker
-----------
@@ -54,6 +65,7 @@ Have a bug? Please create an issue here on GitHub!
https://github.com/twitter/bootstrap/issues
+
Twitter account
---------------
@@ -78,6 +90,7 @@ twitter-bootstrap@googlegroups.com
http://groups.google.com/group/twitter-bootstrap
+
IRC
---
@@ -86,8 +99,9 @@ Server: irc.freenode.net
Channel: ##twitter-bootstrap (the double ## is not a typo)
-SASS Developers
----------------
+
+SASS: Developers
+----------------
We have included a Rakefile with convenience methods for working with the SASS Bootstrap library.
@@ -99,6 +113,7 @@ The lessc compiler is required for this command to run.
This is a convenience method for watching your Sass files and automatically building them whenever you save.
+
Developers
----------
@@ -121,6 +136,7 @@ Runs jshint and qunit tests headlessly in phantom js (used for ci). Depends on h
This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.
+
Authors
-------
@@ -135,6 +151,7 @@ Authors
+ http://github.com/fat
+
Sass Conversion
---------------
@@ -158,6 +175,7 @@ The Twitter Bootstrap was lovingly converted to Sass by:
And [others](https://github.com/jlong/sass-twitter-bootstrap/contributors)
+
Copyright and license
---------------------
View
10 js/README.md
@@ -5,9 +5,9 @@ These are the high-level design rules which guide the development of Bootstrap's
### DATA-ATTRIBUTE API
-We believe you should be able to use all plugins provided by Bootstrap purely through the markup API without writing a single line of javascript. This is bootstraps first class api.
+We believe you should be able to use all plugins provided by Bootstrap purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first class API.
-We acknowledge that this isn't always the most performant and sometimes it may be desirable to turn this functionality off altogether. Therefore, as of 2.0 we provide the ability to disable the data attribute API by unbinding all events on the body namespaced with `'data-api'`. This looks like this:
+We acknowledge that this isn't always the most performant and it may sometimes be desirable to turn this functionality off altogether. Therefore, as of 2.0 we provide the ability to disable the data attribute API by unbinding all events on the body namespaced with `'data-api'`. This looks like this:
$('body').off('.data-api')
@@ -19,7 +19,7 @@ To target a specific plugin, just include the plugins name as a namespace along
### PROGRAMATIC API
-We also believe you should be able to use all plugins provided by Bootstrap purely through the JS API.
+We also believe you should be able to use all plugins provided by Bootstrap purely through the JavaScript API.
All public APIs should be single, chainable methods, and return the collection acted upon.
@@ -45,7 +45,7 @@ An options definition should take the following form:
*noun*: *adjective* - describes or modifies a quality of an instance
-examples:
+Examples:
backdrop: true
keyboard: false
@@ -93,7 +93,7 @@ Data attributes should take the following form:
- data-target || href^=# - defined on "control" element (if element controls an element other than self)
- data-{{noun}} - defines class instance options
-examples:
+Examples:
// control other targets
data-toggle="modal" data-target="#foo"

0 comments on commit 8dcea11

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