README.md 1.78 KB
Newer Older
Thomas Park's avatar
Thomas Park committed
1 2 3
Bootswatch
==========

Chris Rebert's avatar
Chris Rebert committed
4
Bootswatch is a collection of free themes for [Bootstrap](http://getbootstrap.com/). Check it out at [bootswatch.com](http://bootswatch.com).
Thomas Park's avatar
Thomas Park committed
5 6 7

Usage
-----
Thomas Park's avatar
Thomas Park committed
8
Download the `bootstrap.min.css` file associated with a theme and replace Bootstrap's default stylesheet.
Thomas Park's avatar
Thomas Park committed
9 10 11

The themes are also hosted on [BootstrapCDN](http://www.bootstrapcdn.com/).

Thomas Park's avatar
Thomas Park committed
12
Rails users should check out [twitter-bootswatch-rails](https://github.com/scottvrosenthal/twitter-bootswatch-rails).
Thomas Park's avatar
Thomas Park committed
13 14 15 16


Customization
------
Thomas Park's avatar
Thomas Park committed
17
Bootswatch is open source and you’re welcome to modify the themes.
Thomas Park's avatar
Thomas Park committed
18

Thomas Park's avatar
Thomas Park committed
19
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.
Thomas Park's avatar
Thomas Park committed
20

Thomas Park's avatar
Thomas Park committed
21
Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
Thomas Park's avatar
Thomas Park committed
22 23 24 25

API
-----

Thomas Park's avatar
Thomas Park committed
26
A simple API is available for integrating your platform with Bootswatch. Send your request to `http://api.bootswatch.com/3/`.
Thomas Park's avatar
Thomas Park committed
27

Thomas Park's avatar
Thomas Park committed
28
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`.
Thomas Park's avatar
Thomas Park committed
29

Thomas Park's avatar
Thomas Park committed
30
More info at http://bootswatch.com/help/#api
Thomas Park's avatar
Thomas Park committed
31 32 33

Author
------
Thomas Park's avatar
Thomas Park committed
34
Thomas Park
Thomas Park's avatar
Thomas Park committed
35

Thomas Park's avatar
Thomas Park committed
36
+ http://github.com/thomaspark
Thomas Park's avatar
Thomas Park committed
37 38 39 40 41 42
+ http://thomaspark.me

Thanks
------
[Mark Otto](http://github.com/markdotto) and [Jacob Thornton](http://github.com/fat) for [Bootstrap](https://github.com/twitter/bootstrap).

Thomas Park's avatar
Thomas Park committed
43
[Jenil Gogari](http://www.jgog.in/) for his contributions to the Flatly theme.
Thomas Park's avatar
Thomas Park committed
44

Thomas Park's avatar
Thomas Park committed
45
[James Taylor](http://github.com/jostylr) for [cors-lite](https://github.com/jostylr/cors-lite).
Thomas Park's avatar
Thomas Park committed
46 47 48 49


Copyright and License
----
Thomas Park's avatar
Thomas Park committed
50
Copyright 2014 Thomas Park
Thomas Park's avatar
Thomas Park committed
51

Thomas Park's avatar
Thomas Park committed
52
Code released under the MIT License.