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

Jenil Gogari's avatar
Jenil Gogari committed
4
Bootswatch is a collection of free themes for [Twitter Bootstrap](http://getbootstrap.com/). Check it out at [bootswatch.com](http://bootswatch.com).
Thomas Park's avatar
Thomas Park committed
5 6 7 8 9 10 11 12 13 14 15 16

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.

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).


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

Jenil Gogari's avatar
Jenil Gogari committed
19
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.
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 26 27

API
-----

A simple API is available for integrating your platform with Bootswatch.

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

Thomas Park's avatar
Thomas Park committed
30
CORS and JSONP are supported. Send your request to `http://api.bootswatch.com/3/`.
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 36 37 38 39 40 41 42 43

Author
------
[Thomas Park](http://github.com/thomaspark)

+ 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
44
[Jenil Gogari](http://www.jgog.in/) for his contributions to the Flatly theme.
Thomas Park's avatar
Thomas Park committed
45

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

[Gerald Hiller](https://twitter.com/geraldhiller) for the favicon.


Copyright and License
----
Thomas Park's avatar
Thomas Park committed
53
Copyright 2013 Thomas Park
Thomas Park's avatar
Thomas Park committed
54 55 56 57 58 59

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.