README.md 1.88 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 22
These files are also available in SASS.

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

API
-----

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

Thomas Park's avatar
Thomas Park committed
30
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
31

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

Author
------
Thomas Park's avatar
Thomas Park committed
36
Thomas Park
Thomas Park's avatar
Thomas Park committed
37

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

Thanks
------
43
[Mark Otto](https://github.com/mdo) and [Jacob Thornton](https://github.com/fat) for [Bootstrap](https://github.com/twitter/bootstrap).
Thomas Park's avatar
Thomas Park committed
44

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

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

[Corey Sewell](https://github.com/cjsewell) for SASS conversion.
Thomas Park's avatar
Thomas Park committed
50 51 52 53


Copyright and License
----
Thomas Park's avatar
Thomas Park committed
54
Copyright 2014 Thomas Park
Thomas Park's avatar
Thomas Park committed
55

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