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

Thomas Park's avatar
Thomas Park committed
4 5 6
[![Bootswatch Logo](./assets/img/logo-dark.png)](http://bootswatch.com)

Bootswatch is a collection of open source themes for [Bootstrap](http://getbootstrap.com/). Check it out at [bootswatch.com](http://bootswatch.com).
Thomas Park's avatar
Thomas Park committed
7 8 9

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

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

14 15 16 17
 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
18 19 20 21


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

Thomas Park's avatar
Thomas Park committed
24
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
25

Thomas Park's avatar
Thomas Park committed
26 27
These files are also available in SASS.

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

API
-----

33
A simple API is available for integrating your platform with Bootswatch. More info at http://bootswatch.com/help/#api
Thomas Park's avatar
Thomas Park committed
34

35 36 37 38
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
39
**Issues:** Provide a detailed report of any bugs you encounter and open an issue on [GitHub](https://github.com/thomaspark/bootswatch/issues).
40

Thomas Park's avatar
Thomas Park committed
41
**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.
42

Thomas Park's avatar
Thomas Park committed
43
**Code:** 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.
Thomas Park's avatar
Thomas Park committed
44 45

**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/).
46

Thomas Park's avatar
Thomas Park committed
47 48
Author
------
Thomas Park's avatar
Thomas Park committed
49
Thomas Park
Thomas Park's avatar
Thomas Park committed
50

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

Thanks
------
56
[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
57

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

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


Copyright and License
----
Thomas Park's avatar
Thomas Park committed
67
Copyright 2014 Thomas Park
Thomas Park's avatar
Thomas Park committed
68

69
Code released under the MIT License.