README in backtracer-0.5.0 vs README in backtracer-0.5.1

- old
+ new

@@ -3,11 +3,11 @@ If you've ever seen ...24 levels... and disliked it, this is the gem for you. -If you've ever wished an exception printout would display the code of the lines in a backtrace (a la Python), this is for you. +If you've ever wished the exception trace would display the code of each line (a la Python), then this gem is for you. It displays the full back trace (no ...'s), along with the code from each line! It can even display local variables at each level of the call stack, if desired. Examples: @@ -28,34 +28,33 @@ go2(a, 55) crash.rb:10 go '3' -(Note--has the code lines, and if there had been ...'s, would have ovecome them). +(Now has the code lines, and if there had been ...'s, would have ovecome them). -or the --locals option +or use the --locals option -$backtracer --locals crash.rb +$ backtracer --locals crash.rb unhandled exception: crash.rb:2: raise locals: {"a"=>"3", "b"=>55} from: crash.rb:1 go2(a=>3, b=>55) locals: {"a"=>"3", "b"=>55} crash.rb:5 go(a=>3) locals: {"a"=>"3"} -(displays locals, parameters kind of) +(displays locals, parameters as current value) -Also included is a --ping option, which periodically dumps current threads' backtrace(s)--quite useful for profiling to see where you code is spending a lot of its time (thanks xray gem!). There is also an option that will print out thread dumps whenever you hit ctrl+c. +Also included are several other options. One is --ping, which periodically dumps current threads' backtrace(s) (quite useful for profiling to see where you code is spending a lot of its time (thanks xray gem!)). There is also an option that will print out thread dumps whenever you hit ctrl+c. To see all possible backtrace options run $ backtracer -h or $ backtracer --help - -More example outputs: +More examples can be found here: http://github.com/rdp/backtracer/blob/master/examples/example_test_all_output http://github.com/rdp/backtracer/blob/master/examples/example_test_large_output http://github.com/rdp/backtracer/blob/master/examples/pinger_example \ No newline at end of file