README.md in ruby_inspector-0.1.0 vs README.md in ruby_inspector-0.2.0
- old
+ new
@@ -1,16 +1,24 @@
-# Ruby Inspector
+# RubyInspector ![](https://travis-ci.org/gingermusketeer/ruby_inspector.svg?branch=master)
Allows for ruby apps to be debugged using the standard chrome developer tools
+# Demo
+
+![RubyInspector demo gif](https://raw.githubusercontent.com/gingermusketeer/ruby_inspector/master/readme/demo.gif)
+
+See [RubyInspector demos](https://github.com/gingermusketeer/ruby_inspector_demos) for more examples
+
# Getting started
1. Get a copy of [chrome devtools app](https://github.com/auchenberg/chrome-devtools-app)
2. Setup and start [ruby_inspector_server](https://github.com/gingermusketeer/ruby_inspector_server)
-3. Run `ruby demo.rb`
-4. Connect the devtools app to your app. apps -> Go
-5. Unleash the app from the breakpoint
-6. Monitor http traffic
+3. Add `gem 'ruby_inspector'` to your gem file
+4. Add `RubyInspector.enable("MyAppName", "Optional description")` to enable monitoring
+5. Add a breakpoint before the network requests are made
+6. Connect the devtools app to your app. apps -> Go
+7. Unleash the app from the breakpoint
+8. Monitor http traffic
# Todo
- Start the server automatically in the background unless it is started (server.pid?)
- Pull the tcp socket port from the node app (socket.port?)