README.md in method_log-0.0.5 vs README.md in method_log-0.0.6

- old
+ new

@@ -2,15 +2,16 @@ Trace the history of an individual method in a git repository. This is a work-in-progress and nowhere near production-ready. -### Dependencies +### Requirements -* Ruby >= v2.0.0 (just because I'm using named parameters) +* Ruby >= v1.9.3 (due to requirements of the `rugged` gem) * The [rugged](https://github.com/libgit2/rugged) Ruby gem (listed as dependency in gemspec) * The [libgit2](https://github.com/libgit2/libgit2) C library (included as part of rugged gem) +* The [parser](https://github.com/whitequark/parser) Ruby gem (listed as dependency in gemspec) ### Install gem install method_log @@ -18,18 +19,15 @@ method_log <method-signature> # e.g. Foo::Bar#baz ### Todo -* Support earlier versions of Ruby (it ought to be possible to support down to v1.9.3 fairly easily) -* Investigate whether parser gem can only parse source code written using the current Ruby version - * It would be nice to have a better error message if parsing fails * Support for Rspec tests * Default to looking for commits in current git branch +* Check what happens with merge commits * Maybe add as new git command or extension to existing command e.g. `git log` * Optimise search for method definitions: * First look in file where method was last defined -* By default stop when method disappears from history * Find "similar" method implementations e.g. by comparing ASTs of implementations ### Credits Written by [James Mead](http://jamesmead.org) and the other members of [Go Free Range](http://gofreerange.com).