Commit fcf36f48 authored by Thomas Park's avatar Thomas Park

update readme

parent 4f92a140
......@@ -5,36 +5,35 @@ Bootswatch is a collection of free themes for [Bootstrap](http://getbootstrap.co
Usage
-----
Head over to [Bootswatch](http://bootswatch.com) and download the `bootstrap.min.css` file associated with a theme. Replace Bootstrap's stylesheet with this file.
Download the `bootstrap.min.css` file associated with a theme and replace Bootstrap's default stylesheet.
The themes are also hosted on [BootstrapCDN](http://www.bootstrapcdn.com/).
For use with Rails, check out [bootswatch-rails](https://github.com/maxim/bootswatch-rails) (Sass) and [twitter-bootswatch-rails](https://github.com/scottvrosenthal/twitter-bootswatch-rails) (LESS). For use with a Yeoman app or with Bower check out [bootswatch-scss](https://github.com/nrub/bootswatch-scss).
Rails users should check out [twitter-bootswatch-rails](https://github.com/scottvrosenthal/twitter-bootswatch-rails).
Customization
------
Bootswatch is an open source project, and you’re welcome to fork and modify the themes.
Bootswatch is open source and you’re welcome to modify the themes.
Each raw theme consists of two LESS files. One is `variables.less`, which is included by default in Bootstrap and allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables). The other is called `bootswatch.less` and introduces more extensive structural changes.
Each theme consists of two LESS files. `variables.less`, which is included by default in Bootstrap, allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables). `bootswatch.less` introduces more extensive structural changes.
Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
API
-----
A simple API is available for integrating your platform with Bootswatch.
A simple API is available for integrating your platform with Bootswatch. Send your request to `http://api.bootswatch.com/3/`.
The swatch objects are housed in an array called `themes`, and each swatch has the following properties: `name`, `description`, `preview`, `thumbnail`, `css`, `cssMin`, `less`, and `lessVariables`.
CORS and JSONP are supported. Send your request to `http://api.bootswatch.com/3/`.
The swatch objects are returned in an array called `themes`, each one with the following properties: `name`, `description`, `preview`, `thumbnail`, `css`, `cssMin`, `less`, and `lessVariables`.
More info at http://bootswatch.com/help/#api
Author
------
[Thomas Park](http://github.com/thomaspark)
Thomas Park
+ http://github.com/thomaspark
+ http://thomaspark.me
Thanks
......@@ -45,11 +44,9 @@ Thanks
[James Taylor](http://github.com/jostylr) for [cors-lite](https://github.com/jostylr/cors-lite).
[Gerald Hiller](https://twitter.com/geraldhiller) for the favicon.
Copyright and License
----
Copyright 2013 Thomas Park
Copyright 2014 Thomas Park
Code released under the MIT License.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment