chrome_debugger 0.0.3 → 0.0.4

data/README.md

@@ -17,34 +17,48 @@ Chrome 18 or higher must be installed and available on the path.
 
 ## Usage
 
-    require 'chrome_debugger'
-
-    ChromeDebugger::Client.open do |chrome|
-      document = chrome.load_url("https://theconversation.edu.au/")
-
-      puts "requests:          #{document.request_count}"
-      puts "onload_event:      #{document.onload_event}"
-      puts "dom_content_event: #{document.dom_content_event}"
-      puts "document_payload:  #{document.encoded_bytes("Document")}"
-      puts "script_payload:    #{document.encoded_bytes("Script")}"
-      puts "image_payload:     #{document.encoded_bytes("Image")}"
-    end
-
-Refer to the ChromeDebugger::Client and ChromeDebugger::Document classes for
+```ruby
+require 'chrome_debugger'
+
+ChromeDebugger::Client.open do |chrome|
+  document = chrome.load_url("https://theconversation.edu.au/")
+
+  puts "request count:                      #{document.request_count}"
+  puts "onload event fired:                 #{document.onload_event}"
+  puts "dom content event fired:            #{document.dom_content_event}"
+  puts "payload document encoded bytes:     #{document.encoded_bytes("Document")}"
+  puts "payload script encoded bytes:       #{document.encoded_bytes("Script")}"
+  puts "payload image encoded bytes:        #{document.encoded_bytes("Image")}"
+  puts "payload stylesheet encoded bytes:   #{document.encoded_bytes("Stylesheet")}"
+  puts "payload other encoded bytes:        #{document.encoded_bytes("Other")}"
+  puts "payload document bytes:             #{document.bytes("Document")}"
+  puts "payload script bytes:               #{document.bytes("Script")}"
+  puts "payload image bytes:                #{document.bytes("Image")}"
+  puts "payload stylesheet bytes:           #{document.bytes("Stylesheet")}"
+  puts "payload other bytes:                #{document.bytes("Other")}"
+  puts "script requests:                    #{document.request_count_by_resource("Script")}"
+  puts "image requests:                     #{document.request_count_by_resource("Image")}"
+  puts "stylesheet requests:                #{document.request_count_by_resource("Stylesheet")}"
+end
+```
+
+Refer to the `ChromeDebugger::Client` and `ChromeDebugger::Document` classes for
 detailed docs.
 
-ChromeDebugger::Client starts and manages a new chrome session.
+`ChromeDebugger::Client` starts and manages a new chrome session.
 
-ChromeDebugger::Document provides an entry point for querying the results of
+`ChromeDebugger::Document` provides an entry point for querying the results of
 a page load.
 
 ## Authors
 
-Justin Morris
-  justin.morris@theconversation.edu.au
+### Justin Morris
+- justin.morris@theconversation.edu.au
+- [@plasticine](http://twitter.com/plasticine)
 
-James Healy
-  james.healy@theconversation.edu.au
+### James Healy
+- james@yob.id.au
+- [@jim_healy](http://twitter.com/jim_healy)
 
 ## Further Reading
 
@@ -57,3 +71,7 @@ Possible further work.
 
 * make the chrome path configurable
 * make headless mode configurable
+ 
+## License
+
+chrome_debugger is Copyright (c) 2012 The Conversation Media Group and distributed under the MIT license.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrome_debugger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -95,7 +95,7 @@ dependencies:
 description: Starts a Google Chrome session. Load pages and examine the results.
 email:
 - justin.morris@theconversation.edu.au
-- james.healy@theconversation.edu.au
+- james@yob.id.au
 executables: []
 extensions: []
 extra_rdoc_files: []