From e6e0cd2bad6769f6a7da3ede5333f4d40799be58 Mon Sep 17 00:00:00 2001
From: Peter Gumeson <gumeson@gmail.com>
Date: Thu, 30 May 2013 00:25:02 -0700
Subject: [PATCH] Moved converter instructions into readme

---
 CONTRIBUTING.md | 17 ++++-------------
 README.md       | 41 +++++++++++++++++++++++++++++++++++++----
 2 files changed, 41 insertions(+), 17 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6d63f874..e2d14ced 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,20 +1,11 @@
 # Contributing to bootstrap-sass
 
-## Upstream Converter
+## Asset Changes
 
-Upsteam changes to the Twitter Bootstrap project can be pulled in using the `convert` rake task.
+Any changes to `bootstrap-sass` assets (scss, javascripts, fonts) should be checked against the `convert` rake task.
+For usage instructions, see the [README](https://github.com/intridea/bootstrap-sass/edit/3.0.0-wip/README.md).
 
-Here's an example run that would pull down the `3.0.0-wip` branch from the main twitter/bootstrap repo:
-
-    % bundle exec rake 'convert[3.0.0-wip]'
-
-The latest converter script is located [here](https://github.com/intridea/bootstrap-sass/blob/3.0.0-wip/tasks/converter.rb) and attempts to do the following:
-
-* Convert upsteam bootstrap Less files to the matching Scss file.
-* TODO: Copy upstream javascript, images and other assets into the bootstrap-sass assets directory.
-
-This conversion is not perfect at this time so manual fixes to the resulting Scss will necessary.
-See [these github issues](https://github.com/intridea/bootstrap-sass/issues?labels=converter&state=open) tagged with `conversion` which track the current shortcomings of the conversion process.
+If something is broken in the converter, it's preferable to update the converter along with the asset itself.
 
 
 ## Bugs
diff --git a/README.md b/README.md
index 9d0bf789..5a1cf8b4 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,40 @@
-# bootstrap-sass 3.0!
+# Bootstrap for Sass
 
-Welcome to the 3 branch.
+`bootstrap-sass` is an Sass-powered version of [Twitter's Bootstrap](http://github.com/twitter/bootstrap), ready to drop right into your Sass powered applications.
 
-## Conversion
+## Usage
 
-If you'd like to help out with the conversion to Twitter Bootstrap 3, please read about how to use the new converter script in the [CONTRIBUTING README](https://github.com/intridea/bootstrap-sass/blob/3.0.0-wip/CONTRIBUTING.md).
+### Rails
+
+In your Gemfile:
+
+```ruby
+gem 'sass-rails',   '~> 3.2.3'
+gem 'bootstrap-sass', :git => 'git://github.com/intridea/bootstrap-sass.git', :branch => '3.0.0-wip'
+```
+
+`bundle install` and restart your server to make the files available.
+
+## Upstream Converter
+
+Keeping bootstrap-sass in sync with upsteam changes from Bootstrap is an error prone and time consuming manual process.
+This branch is specifically concerned with automating that process as much as possible to allow a much faster release cycle.
+
+Upsteam changes to the Twitter Bootstrap project can now be pulled in using the `convert` rake task.
+
+Here's an example run that would pull down the `3.0.0-wip` branch from the main twitter/bootstrap repo:
+
+    % bundle exec rake 'convert[3.0.0-wip]'
+
+The latest converter script is located [here](https://github.com/intridea/bootstrap-sass/blob/3.0.0-wip/tasks/converter.rb) and does the following:
+
+* Converts upsteam bootstrap Less files to its matching Scss file.
+* Copies all upstream javascripts into `vendor/assets/javascripts/bootstrap`
+* Generates a javascript manifest at `vendor/assets/javascripts/bootstrap.js`
+* Copies all upstream font files into `vendor/assets/fonts`
+
+This less to scss conversion is pretty good, but not perfect. So manual fixes to the resulting Scss will necessary for now.
+See [these github issues](https://github.com/intridea/bootstrap-sass/issues?labels=converter&state=open) tagged with `conversion` which track the current shortcomings of the conversion process.
+
+## Who
+bootstrap-sass is a project by [Thomas McDonald](https://twitter.com/#!/thomasmcdonald_), with support from [other awesome people](https://github.com/thomas-mcdonald/bootstrap-sass/graphs/contributors).