Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updating readme

  • Loading branch information...
commit ea6d10b96ea9dcac0032479e31883f0e9692fa6c 1 parent 7f9c64f
@mikeyp mikeyp authored
Showing with 22 additions and 73 deletions.
  1. +22 −73 README.md
View
95 README.md
@@ -1,90 +1,34 @@
-TWITTER BOOTSTRAP
-=================
+# bootstrap-stylus
-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.
+A basic port of the Twitter Bootstrap CSS framework to stylus. Ideal for node.js apps using connect or express.
-To get started -- checkout http://twitter.github.com/bootstrap!
+To learn more about using the framework see the bootstrap docs at http://twitter.github.com/bootstrap.
-Usage
------
+## Use
-You can use Twitter Bootstrap in one of two ways: just drop the compiled CSS into any new project and start cranking, or run LESS on your site and compile on the fly like a boss.
+Javascript - just add it to stylus's paths:
-Here's what the LESS version looks like:
+ stylus(content).set('paths',[require('bootstrap-stylus')]).render(....)
-``` html
-<link rel="stylesheet/less" type="text/css" href="lib/bootstrap.less">
-<script src="less.js" type="text/javascript"></script>
-```
-Or if you prefer, the standard css way:
+in your .style files:
-``` html
-<link rel="stylesheet" type="text/css" href="bootstrap.css">
-```
+ @import bootstrap
-For more info, refer to the docs!
+or set variables before importing:
+ $linkColor = red
+ @import bootstrap
-Versioning
-----------
+You can also import individual files by specifying their filename:
-For transparency and insight into our release cycle, and for striving to maintain backwards compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.
+ @import reset
-Releases will be numbered with the follow format:
-`<major>.<minor>.<patch>`
+## Authors
-And constructed with the following guidelines:
-
-* Breaking backwards compatibility bumps the major
-* New additions without breaking backwards compatibility bumps the minor
-* Bug fixes and misc changes bump the patch
-
-For more information on SemVer, please visit http://semver.org/.
-
-
-Bug tracker
------------
-
-Have a bug? Please create an issue here on GitHub!
-
-https://github.com/twitter/bootstrap/issues
-
-
-Twitter account
----------------
-
-Keep up to date on announcements and more by following Bootstrap on Twitter, <a href="http://twitter.com/TwBootstrap">@TwBootstrap</a>.
-
-
-Mailing list
-------------
-
-Have a question? Ask on our mailing list!
-
-twitter-bootstrap@googlegroups.com
-
-http://groups.google.com/group/twitter-bootstrap
-
-
-Developers
-----------
-
-We have included a makefile with convenience methods for working with the bootstrap library.
-
-+ **build** - `make build`
-This will run the less compiler on the bootstrap lib and generate a bootstrap.css and bootstrap.min.css file.
-The lessc compiler is required for this command to run.
-
-+ **watch** - `make watch`
-This is a convenience method for watching your less files and automatically building them whenever you save.
-Watchr is required for this command to run.
-
-
-Authors
--------
+### Twitter Bootstrap by:
**Mark Otto**
@@ -96,9 +40,14 @@ Authors
+ http://twitter.com/fat
+ http://github.com/fat
+### Port to stylus by
+
+**Michael Prasuhn**
+
++ http://twitter.com/mikey_p
++ https://github.com/mikeyp
-License
----------------------
+## License
Copyright 2011 Twitter, Inc.
Please sign in to comment.
Something went wrong with that request. Please try again.