Permalink
Browse files

Write some stuff in README.

  • Loading branch information...
1 parent 6776f0e commit 616767d3cbc8dab4fc54481b972a9a4d2ff36b95 @maxim committed Mar 16, 2012
Showing with 41 additions and 7 deletions.
  1. +39 −7 README.md
  2. +2 −0 bootswatch-rails.gemspec
View
@@ -1,24 +1,48 @@
-# Bootswatch::Rails
+# bootswatch-rails
-TODO: Write a gem description
+This gem is meant to be used with [bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass). It gives you complete scss versions of [bootswatches](http://bootswatch.com) for use in your Rails 3 asset pipeline, just like bootstrap-sass gives you scss version of bootstrap itself.
## Installation
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile, in assets group:
gem 'bootswatch-rails'
And then execute:
$ bundle
-Or install it yourself as:
+## Usage
- $ gem install bootswatch-rails
+When using bootstrap-sass, it's recommended to avoid sprockets in your stylesheets. In order to do that you simply rename your `application.css` file to `application.css.scss`, remove all sprockets comments, and instead use sass `@import` commands. These commands are smart enough to fully support asset pipeline load paths, thanks to `sass-rails` gem.
-## Usage
+Here's approximately how your `application.css.scss` file should look like, considering that you're using [bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass).
+
+ // Example using journal bootswatch
+ //
+ // First import journal variables
+ @import "bootswatch/journal/variables";
+
+ // Then bootstrap itself
+ @import "bootstrap";
+
+ // Bootstrap body padding for fixed navbar
+ body { padding-top: 60px; }
+
+ // Responsive styles go here in case you want them
+ @import "bootstrap-responsive";
+
+ // And finally bootswatch style itself
+ @import "bootswatch/journal/bootswatch";
-TODO: Write usage instructions here
+ // Whatever application styles you have go last
+ @import "base";
+
+## Bootswatches
+
+I'm converting/updating them as time permits. Here's what's included at this point.
+
+* [journal](http://bootswatch.com/journal/)
## Contributing
@@ -27,3 +51,11 @@ TODO: Write usage instructions here
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Credits
+
+Big thanks to these guys.
+
+[Thomas Park](http://github.com/thomaspark) for [bootswatch](http://bootswatch.com/)
+
+[Thomas McDonald](http://github.com/thomas-mcdonald) for [bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass)
View
@@ -8,6 +8,8 @@ Gem::Specification.new do |gem|
gem.summary = %q{Bootswatches in your Rails asset pipeline}
gem.homepage = "http://github.com/maxim/bootswatch-rails"
+ gem.add_dependency 'railties', '>= 3.1'
+
gem.files = `git ls-files`.split($\)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.name = "bootswatch-rails"

0 comments on commit 616767d

Please sign in to comment.