README.md in method_log-0.2.0 vs README.md in method_log-0.2.1
- old
+ new
@@ -1,15 +1,15 @@
-## Method Log
+## Method Log [](https://travis-ci.org/freerange/method_log) [](https://badge.fury.io/rb/method_log)
Trace the history of an individual method in a git repository (experimental).
+See [this article](https://gofreerange.com/tracing-the-git-history-of-a-ruby-method) for more information.
+
### Requirements
-* Ruby >= v2.0.0 (due to requirements of the `parser` gem); although parsing of source code for Ruby >= v1.8 is possible
-* 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)
+* Tool runtime: Ruby >= v2.0.0
+* Source code under analysis: Ruby >= v1.8
### Install
gem install method_log
@@ -20,17 +20,9 @@
$ method_log [options] <method-signature>
#### Build a parallel git repository of method definitions
$ build_methods_repo [options] <source-repo-path> <target-repo-path>
-
-### To Do
-
-* Parsing 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`
-* 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).