README.md 2.91 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

Thomas Park's avatar
Thomas Park committed
10
The themes are also hosted on [BootstrapCDN](http://www.bootstrapcdn.com/bootswatch/).
Thomas Park's avatar
Thomas Park committed
11

12 13 14 15
 Rails users should check out:

* [twitter-bootswatch-rails](https://github.com/scottvrosenthal/twitter-bootswatch-rails) if using _LESS_.
* [bootswatch-rails](https://github.com/maxim/bootswatch-rails) if using _SASS_.
Thomas Park's avatar
Thomas Park committed
16 17 18 19


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

Thomas Park's avatar
Thomas Park committed
22
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
23

Thomas Park's avatar
Thomas Park committed
24 25
These files are also available in SASS.

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

API
-----

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

Thomas Park's avatar
Thomas Park committed
33
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
34

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

37 38 39 40
Contributing
-----
It's through your contributions that Bootswatch will continue to improve. You can contribute in several ways.

Thomas Park's avatar
Thomas Park committed
41
**Issues:** Provide a detailed report of any bugs you encounter and open an issue on [GitHub](https://github.com/thomaspark/bootswatch/issues).
42

Thomas Park's avatar
Thomas Park committed
43
**Documentation:** If you'd like to fix a typo or beef up the docs, you can fork the project, make your changes, and submit a pull request.
44

Thomas Park's avatar
Thomas Park committed
45 46 47
**Code:** You're more than welcome to make a fix and submit it as a pull request. When making changes, it's important to keep the CSS, LESS and SASS versions in sync. To do this, be sure to edit the LESS source files for the particular theme, then run the  tasks `grunt swatch` and `grunt:convert_less` to build the CSS and LESS.

**Donation:** Donations are gratefully accepted via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=F22JEM3Q78JC2) and [Gratipay](https://gratipay.com/bootswatch/).
48

Thomas Park's avatar
Thomas Park committed
49 50
Author
------
Thomas Park's avatar
Thomas Park committed
51
Thomas Park
Thomas Park's avatar
Thomas Park committed
52

Thomas Park's avatar
Thomas Park committed
53
+ http://github.com/thomaspark
Thomas Park's avatar
Thomas Park committed
54
+ http://thomaspark.co
Thomas Park's avatar
Thomas Park committed
55 56 57

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

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

Thomas Park's avatar
Thomas Park committed
62 63 64
[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
65 66 67 68


Copyright and License
----
Thomas Park's avatar
Thomas Park committed
69
Copyright 2014 Thomas Park
Thomas Park's avatar
Thomas Park committed
70

71
Code released under the MIT License.