README.rdoc in watir-performance-0.5.0 vs README.rdoc in watir-performance-0.5.1
- old
+ new
@@ -1,12 +1,20 @@
-= watir-webdriver-performance
-Predecessor to https://github.com/90kts/watir-webdriver-performance for Watir as opposed to watir-webdriver
+= watir-performance
+{<img src="https://badge.fury.io/rb/watir-performance.svg" alt="Gem Version" />}[https://badge.fury.io/rb/watir-performance]
+{<img src="https://beta.gemnasium.com/badges/github.com/MacCracken/watir-performance.svg" alt="Dependency Status" />}[https://beta.gemnasium.com/projects/github.com/MacCracken/watir-performance]
+{<img src="https://api.codeclimate.com/v1/badges/ce9c9de5e6146dedab27/maintainability" />}[https://codeclimate.com/github/MacCracken/watir-performance/maintainability]
+{<img src="https://travis-ci.org/MacCracken/watir-performance.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/MacCracken/watir-performance]
+
+Predecessor to https://github.com/90kts/watir-webdriver-performance for Watir as opposed to watir-webdriver.
+
+The Watir-Performance aims to provide a set of navigation timing metrics for Watir[https://github.com/watir/watir] actions using a {W3C page performance standard}[http://w3c-test.org/webperf/specs/NavigationTiming/]. This is a perfect solution to capture response time metrics, and it’s very straightforward to do. Works for Chrome, Firefox, Edge and IE9 and up. Currently no Safari support.
+
This gem collects and summarises metrics speficied in the W3C Navigation
web performance specifications at
https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/NavigationTiming/Overview.html when using
-watir-webdriver and a compatible browser.
+watir and a compatible browser.
== Example output of browser.performance
All summary times are in milliseconds, and are an abstraction of the w3c
web performance specification.
@@ -60,10 +68,10 @@
:redirect_start => 0,
:unload_event_end => 0
}
}
-== Contributing to watir-webdriver-performance
+== Contributing to watir-performance
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch