README.md in unused_css-0.0.1 vs README.md in unused_css-0.1.0
- old
+ new
@@ -1,6 +1,85 @@
Unused CSS
==========
[](https://travis-ci.org/christemple/unused-css)
-A Ruby gem, built from a need, to watch a suite of functional tests and gather all of the unused CSS styles.
\ No newline at end of file
+A Ruby gem, built from a need, to watch a suite of functional tests and gather all of the unused CSS styles.
+
+Install
+-------
+
+```ruby
+gem install unused_css
+```
+
+
+How to use
+----------
+
+Here's a typical 'features/support/env.rb' file using Unused CSS to watch the Watir webdriver as it runs your functional tests:
+
+```ruby
+require "watir-webdriver"
+require "unused_css"
+
+$browser = Watir::Browser.new
+$unused_css = UnusedCSS::Watcher.new
+$unused_css.watch! $browser
+
+at_exit do
+ $browser.close
+
+ # A list of all stylehseets together with their unused styles
+ puts "Unused CSS"
+ $unused_css.stylesheets.each do |stylesheet|
+ puts stylesheet.uri
+ stylesheet.styles.each { |style| puts style }
+ end
+
+end
+```
+
+How it works
+------------
+
+Unused CSS will override the 'goto' method on Watir webdriver. After going to the specified web page, it will grab any
+new stylesheets it may have found and scan all stylesheets it knows about removing any used css found on the page.
+
+
+Checking for unused css/styles on your terms (AJAX scenario)
+----------
+
+I thought it would be nice to also put you in control of when you want to check for used styles on a page.
+A page that relies on AJAX to dynamically load content will likely benefit from being able to do so.
+
+In one of your step definitions you can simply call:
+
+```ruby
+When(/^I recheck the styles on the page$/) do
+
+ # Where $browser is an instance of Watir webdriver that you
+ # have called the unused css watch! method on
+
+ $browser.check_for_unused_styles!
+end
+```
+
+Limitations
+-----------
+
+Unused CSS currently only works with Watir webdriver, I will be adding more webdrivers soon.
+
+TODO
+----
+
+There are still a few things I am looking to do with this Ruby gem.
+- Add support for more web drivers.
+- Add ability to create report after watching the tests.
+- ...not sure, you tell me :)
+
+
+Feedback
+--------
+Please send me a message or an email and let me know what you think.
+
+Chris Temple