From 1cd9b7522d4a5b86605f2006a7b9a5dddb28bb32 Mon Sep 17 00:00:00 2001 From: Petr Schreiber Date: Thu, 25 Aug 2016 14:12:25 +0200 Subject: [PATCH] chore: cleaning up the README.md --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a7a8b4e..a356386 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,21 @@ # TestAggregation -Simple model for reading stream of step results that can grup and aggregate -results by part and machine (in feature by any param). +Simple model for reading stream of step results that can group and aggregate +results by part and machine. ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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 exec rake release` which will create a git tag for the version +* push git commits and tags ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/final-test_aggregation. - +Bug reports and pull requests are welcome on GitHub at https://github.com/AVGTechnologies/test-aggregation ## License