README.md in method_locator-0.0.3 vs README.md in method_locator-0.0.4
- old
+ new
@@ -1,23 +1,28 @@
-# Method Locator
+# method_locator
-Method Locator is a Ruby gem that allows you to easily determine the method lookup path of a particular
+method_locator is a Ruby gem that allows you to easily determine the method lookup path of a particular
object / class / module, as well as find all places (represented as UnboundMethod instances) where
a callable method is defined on an object. This is very useful in an environment such as Rails where
you are unsure where a method may be defined or overridden. Note that by default, Ruby tends to hide
singleton classes when you invoke Module#ancestors. The new Object#method_lookup_path does not hide
these singleton classes and will return them, so that you get a true representation of how Ruby
performs lookups for methods.
+This library will make more sense if you understand Ruby's object model and method lookup path.
+A great explanation of this can be found in the following article by Andrea Singh: [Ruby's Eigenclasses Demystified](http://blog.madebydna.com/all/code/2011/06/24/eigenclasses-demystified.html)
+
## Installation
-Method Locator is available as a RubyGem:
+method_locator is available as a Ruby gem:
gem install method_locator
## Examples
```ruby
+require 'method_locator'
+
module M1
def foo
puts "foo from M1"
end
end
\ No newline at end of file