README.md in method_log-0.0.6 vs README.md in method_log-0.0.7
- old
+ new
@@ -1,11 +1,9 @@
## Method Log
-Trace the history of an individual method in a git repository.
+Trace the history of an individual method in a git repository (experimental).
-This is a work-in-progress and nowhere near production-ready.
-
### Requirements
* 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)
@@ -15,10 +13,20 @@
gem install method_log
### Run
- method_log <method-signature> # e.g. Foo::Bar#baz
+ $ method_log <options> <method-signature>
+
+ # options:
+ --patch, -p: Generate patch.
+ --ruby-version, -r <s>: Parser Ruby version (18, 19, 20, 21) (default: current)
+ --max-count, -n <i>: Limit the number of commits to output.
+ --stop-at-latest-introduction-of-method, -s: Stop at lastest introduction of method.
+ --help, -h: Show usage.
+
+ # method-signature
+ Uses the Ruby Index format e.g. Foo#bar, Bar::Baz#foo, Baz.foo.
### Todo
* Support for Rspec tests
* Default to looking for commits in current git branch