README.md in method_found-0.0.1 vs README.md in method_found-0.1.0
- old
+ new
@@ -1,40 +1,36 @@
# MethodFound
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/method_found`. To experiment with that code, run `bin/console` for an interactive prompt.
+Intercept `method_missing` and do something useful with it.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
-Add this line to your application's Gemfile:
+Add to your Gemfile:
```ruby
-gem 'method_found'
+gem 'method_found', '~> 0.1.0'
```
-And then execute:
+And bundle it.
- $ bundle
-
-Or install it yourself as:
-
- $ gem install method_found
-
## Usage
-TODO: Write usage instructions here
+Include an instance of `MethodFound` with a regex to match and block which
+takes the method name, regex matches, and arguments and does something with it:
-## Development
+```ruby
+class Foo
+ include(MethodFound.new(/\Asay_([a-z]+)/Z/) do |method_name, matches, *arguments|
+ "#{matches[0]}!"
+ end)
+end
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/method_found. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+foo = Foo.new
+foo.say_hello
+#=> "hello!"
+foo.say_bye
+#=> "bye!"
+```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).