README.md in peek-a-view-0.0.3 vs README.md in peek-a-view-0.0.4
- old
+ new
@@ -1,9 +1,7 @@
# PeekAView
-Experimental software ahead! Use with caution, if at all.
-
## What?
This gem provides a Rails engine adds functionality to an application
to show any of its views with stubbed data.
@@ -52,8 +50,51 @@
Start your rails application and point your browser at
http://localhost:3000/peek-a-view/
If everything went well, you see a list of links to your views.
+
+
+## Checking & Reporting
+
+Peek-a-View includes a few Rake tasks and their support code for
+checking the stubbed views with. Currently supported are
+
+* the HTML5 validator from http://validator.nu/
+* YSlow
+
+The checkers are available through these tasks
+
+ rake peek-a-view:check # Run all checks
+ rake peek-a-view:check:html # Check view markup with validator.nu
+ rake peek-a-view:check:speed # Check views with YSlow and generate reports
+ rake peek-a-view:report # Run all checks and generate reports
+ rake peek-a-view:report:html # Check view markup with validator.nu and generate reports
+ rake peek-a-view:report:speed # Check views with YSlow and generate reports
+
+Checks write their output to the console, reports generate xUnit-style (aka surefire)
+reports in reports/html_validator and reports/yslow respectively.
+
+These tasks have dependencies that are not explicitly declared for this gems.
+This is to avoid dragging in gems for task that you may not want to use.
+
+### Requirements for HTML5 checking/reporting
+
+HTML5 checks require at instance of Validator.nu to be available at
+http://localhost:8888/ or whatever URI the environment variable HTML_VALIDATOR
+contains.
+
+You can obtain the sources for the validator from
+http://about.validator.nu/#src
+
+
+### YSlow
+
+YSlow runs as a JavaScript in the headless browser PhantomJS.
+A version of the YSlow script itself is packaged with this gem.
+To use it, you need to install PhantomJS
+
+http://code.google.com/p/phantomjs/
+
This project rocks and uses MIT-LICENSE.