README.md in gh-issues-inspector-0.5.0 vs README.md in gh-issues-inspector-0.5.1

- old
+ new

@@ -64,22 +64,26 @@ inspector = Inspector::Inspector.new "orta", "eigen" inspector.search_query "Someone set us up the bomb", ArtsyUI.new ``` Protocol for custom objects: - - `inspector_started_query(_query, inspector)` - Called just as the investigation has begun. - - `inspector_successfully_recieved_report(report, _inspector)` - Called once the inspector has recieved a report with more than one issue. - - `inspector_recieved_empty_report(_report, inspector)` - Called once the report has been recieved, but when there are no issues found. + - `inspector_started_query(query, inspector)` - Called just as the investigation has begun. + - `inspector_successfully_recieved_report(report, inspector)` - Called once the inspector has recieved a report with more than one issue. + - `inspector_recieved_empty_report(report, inspector)` - Called once the report has been recieved, but when there are no issues found. - `inspector_could_not_create_report(error, query, inspector)` - Called when there have been networking issues in creating the report. ## 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. The usage section of this README is generated from inline documentation inside the classes, to update it run `rake readme`. 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). + +## Vision + +I don't expect this project to grow too much, there's space around improving the search query for an exception, mainly. Other than that the project is effectively done and just needs some production usage to iron out any kinks. This project is well tested, and has zero dependencies. ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/orta/gh-issues-inspector.