README.md in arugula-0.2.0 vs README.md in arugula-0.2.1

- old
+ new

@@ -1,11 +1,10 @@ # Arugula -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/arugula`. To experiment with that code, run `bin/console` for an interactive prompt. +`Arugula` is a naïve (and incomplete) regular expression implementation written +from scratch on a Friday night. -TODO: Delete this and the text above, and describe your gem - ## Installation Add this line to your application's Gemfile: ```ruby @@ -20,22 +19,37 @@ $ gem install arugula ## Usage -TODO: Write usage instructions here +```ruby +regexp = Arugula.new('[A-Z][a-z]+') +regexp.match?('ahoy! my name is Samuel') # => 17 +regexp.match?('foobar') # => null +``` ## Development -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. +After checking out the repo, run `bin/setup` to install dependencies. +Then, run `bin/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). +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`, +run `bundle install`, commit, +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]/arugula. 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. +Bug reports and pull requests are welcome on GitHub at +https://github.com/segiddins/arugula. +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. - ## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). - +The gem is available as open source under the terms of the +[MIT License](http://opensource.org/licenses/MIT).