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

   1 Bootswatch
   2 ==========
   3
   4 Bootswatch is a collection of free themes for [Bootstrap](http://getbootstrap.com/). 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). For use with a Yeoman app or with Bower check out [bootswatch-scss](https://github.com/nrub/bootswatch-scss).
  13
  14
  15 Customization
  16 ------
  17 Bootswatch is an open source project, and you’re welcome to fork and modify the themes.
  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://getbootstrap.com/customize/#less-variables). The other is called `bootswatch.less` and introduces more extensive structural changes.
  20
  21 Check out the [Help page](http://bootswatch.com/help/) for more details on building your own theme.
  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`, `cssMin`, `less`, and `lessVariables`.
  29
  30 CORS and JSONP are supported. Send your request to `http://api.bootswatch.com/3/`.
  31
  32 More info at http://bootswatch.com/help/#api
  33
  34 Author
  35 ------
  36 [Thomas Park](http://github.com/thomaspark)
  37
  38 + http://thomaspark.me
  39
  40 Thanks
  41 ------
  42 [Mark Otto](http://github.com/markdotto) and [Jacob Thornton](http://github.com/fat) for [Bootstrap](https://github.com/twitter/bootstrap).
  43
  44 [Jenil Gogari](http://www.jgog.in/) for his contributions to the Flatly theme.
  45
  46 [James Taylor](http://github.com/jostylr) for [cors-lite](https://github.com/jostylr/cors-lite).
  47
  48 [Gerald Hiller](https://twitter.com/geraldhiller) for the favicon.
  49
  50
  51 Copyright and License
  52 ----
  53 Copyright 2013 Thomas Park
  54
  55 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
  56
  57 http://www.apache.org/licenses/LICENSE-2.0
  58
  59 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.