README.md in stack_tracy-0.1.2 vs README.md in stack_tracy-0.1.3
- old
+ new
@@ -8,10 +8,12 @@
The gem is partly written in C to reduce the application performance as minimal as possible.
![Dick .. Stack Tracy](http://codehero.es/images/stack_tracy.jpg)
+Watch ["**Using StackTracy within a small Sinatra application**"](https://vimeo.com/archan937/stacktracy) to see StackTracy in action!
+
## Installation
### Add `StackTracy` to your Gemfile
gem "stack_tracy"
@@ -138,16 +140,17 @@
[1] pry(main)> StackTracy.start
[2] pry(main)> puts "testing"
=> testing
[3] pry(main)> StackTracy.stop
+ [4] pry(main)> StackTracy.print
Kernel#puts <0.000121>
IO#puts <0.000091>
IO#write <0.000032>
IO#write <0.000020>
=> nil
- [4] pry(main)> StackTracy.dump "result.csv"
+ [5] pry(main)> StackTracy.dump "result.csv"
=> true
#### CSV sample file
This is what the contents of `result.csv` would look like:
@@ -285,10 +288,10 @@
Open the Sinatra application in your browser at [http://localhost:4567](http://localhost:4567) and open [http://localhost:4567/tracy](http://localhost:4567/tracy) afterwards and the complete stack tree will be displayed in your browser! ^^
### Taking more control
-I can imagine that you don't want to hook into every Sinatra request. So you can pass a block which will be yielded before every request. The request will traced when it does **note** return either `false` or `nil`:
+I can imagine that you don't want to hook into every Sinatra request. So you can pass a block which will be yielded before every request. The request will traced when it does **not** return either `false` or `nil`:
use StackTracy::Sinatra do |path, params|
path == "/" #=> only trace "http://localhost:4567"
end
\ No newline at end of file