git.roojs.org Git - bootswatch/blob - README.md

   1 Bootswatch
   2 ==========
   3
   4 Bootswatch is a collection of free themes for [Twitter Bootstrap](http://twitter.github.com/bootstrap/). Check it out at [bootswatch.com](http://bootswatch.com).
   5
   6 Usage
   7 -----
   8 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.
   9
  10 The themes are also hosted on [BootstrapCDN](http://www.bootstrapcdn.com/).
  11
  12 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).
  13
  14
  15 Customization
  16 ------
  17 Bootswatch is an open source project, and you’re welcome to modify the themes further. If you’re interested, fork or follow the GitHub repository. The files of interest are in the `gh-pages` branch.
  18
  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://twitter.github.com/bootstrap/less.html#variables). The other is called `bootswatch.less` and introduces more extensive structural changes.
  20
  21 Check out the README in the [swatchmaker directory](https://github.com/thomaspark/bootswatch/tree/master/swatchmaker) for step-by-step instructions on building your own swatch.
  22
  23 API
  24 -----
  25
  26 A simple API is available for integrating your platform with Bootswatch.
  27
  28 The swatch objects are housed in an array called `themes`, and each swatch has the following properties:  `name`, `description`, `preview`, `thumbnail`, `css`, `css-min`, `less`, and `less-variables`.
  29
  30 CORS and JSONP are supported. Send your request to `http://api.bootswatch.com`.
  31
  32 A simple demo, using mustache.js for templating: http://jsbin.com/asowud/1/edit
  33
  34 Feedback
  35 ------
  36 Please send feedback to thomas@thomaspark.me. For more information, visit http://thomaspark.me/2012/02/introducing-bootswatch/.
  37
  38 Author
  39 ------
  40 [Thomas Park](http://github.com/thomaspark)
  41
  42 + http://thomaspark.me
  43
  44 Thanks
  45 ------
  46 [Mark Otto](http://github.com/markdotto) and [Jacob Thornton](http://github.com/fat) for [Bootstrap](https://github.com/twitter/bootstrap).
  47
  48 [James Taylor](http://github.com/jostylr) for [cors-lite](https://github.com/jostylr/cors-lite).
  49
  50 [Zack Maril](http://github.com/zmaril) for [bootswatch/swatchmaker/watcher.rb](https://github.com/thomaspark/bootswatch/blob/master/swatchmaker/watcher.rb).
  51
  52 [Gerald Hiller](https://twitter.com/geraldhiller) for the favicon.
  53
  54
  55 Copyright and License
  56 ----
  57 Copyright 2012 Thomas Park
  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
  60
  61 http://www.apache.org/licenses/LICENSE-2.0
  62
  63 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.