README.md in log-analyser-0.1.3.pre.documentation.20201108193310 vs README.md in log-analyser-0.1.3.pre.documentation.20201108212148

- old
+ new

@@ -99,16 +99,16 @@ > $ bundle install > ``` #### Usage -Call `./bin/parse_pageview_file.rb` passing a logfile path as argument, will return the pageview count ordered from most to less viewed.</br> -Check the script with `--help` argument for more options +Call `./bin/parse_pageview_file.rb` passing a logfile path as argument, it will return the pageview count ordered from most to less viewed.</br> +Check `--help` for more options ![image](https://user-images.githubusercontent.com/3502642/98471556-0c265c00-21e5-11eb-8fc3-c029e09e41fa.png) -An example log can be found in `resources` folder: +An example log can be found in :file_folder:`resources` folder: $ ./bin/parse_pageview_file.rb --file 'resources/webserver.log' |--------------------------------------------------| | All pageviews | |--------------------------------------------------| @@ -167,25 +167,35 @@ $ bundle install ``` And the world is your oyster... -You can also run `Bundle exec console` for an interactive prompt that will allow you to experiment. +You can also run `bundle exec 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`, 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). #### Linter (rubocop) _*Rubocop*_ is used as code analyser and maintain code formatting (as well as some best practices). -Use `Bundle exec rake rubocop` to run the checks. +Use `$ bundle exec rake rubocop` to run the checks. #### Test coverage -Use `Bundle exec rake rspec` to run the tests. +[![Coverage Status](https://coveralls.io/repos/github/DMazzei/log-analyser/badge.svg?branch=master)](https://coveralls.io/github/DMazzei/log-analyser?branch=master) +Use `$ bundle exec rake spec:all` to run all the tests. + +:white_check_mark: To run only unit-tests + + $bundle exec rake spec:unit + +:white_check_mark: To run only integration tests + + $bundle exec rake spec:integration + The test coverage is handled by `rspec`, `simplecov` and `coveralls`. Status and coverage history can be checked [here](https://coveralls.io/github/DMazzei/log-analyser). #### Deployment @@ -195,19 +205,21 @@ After passing all checks and requirements on github, a *PR* can be merged as soon as it is reviewed and approved. The _*master branch*_ merge process will trigger the deployment process on CircleCI, and this workflow ends with the generation of a _*tagged-gem*_. The whole deployment process will finish by building and tagging a new gem version and pushing it to [rubygems.org](https://rubygems.org/gems/log-analyser). -> :warning: In order to merge changes into _*master branch*_, the version must be bumped up, otherwise the deployment will fail.</br> +> :warning: To merge changes into _*master*_, the version must be bumped up, otherwise the deployment will fail!</br> > The version must be updated in `version.rb`. ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/DMazzeig/log-analyser. ## Next Steps - Extend the logfile formatting; +- Add more options for sorting and filtering; +- Automate library version bump up; ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).