README.md in log_parser-1.0.0 vs README.md in log_parser-1.1.0

- old
+ new

@@ -1,8 +1,8 @@ # LogParser -TODO: Write a gem description +A simple class for searching through a log ## Installation Add this line to your application's Gemfile: @@ -16,11 +16,18 @@ $ gem install log_parser ## Usage -TODO: Write usage instructions here +The class overs a some methods for scanning through a log `by_message(msg)`, `erors`, `warnings`, `since(datetime)` and `uniq`. +These methods can be chained together to refine your search. For example: +```Ruby +log = LogParser::Client.new('some.log') +log.errors.by_message('authentication failed').since(1.day.ago) +#=> ["[2014-11-13T23:12:14-07:00] ERROR [page_id 95239] Authentication failed with token ..."] +``` + ## Contributing 1. Fork it ( https://github.com/[my-github-username]/log_parser/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`)