README.md in loog-0.5.2 vs README.md in loog-0.5.3

- old
+ new

@@ -1,6 +1,6 @@ -<img src="/logo.svg" width="64px" height="64px"/> +# Object-Oriented Logger for Ruby [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org) [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/loog)](http://www.rultor.com/p/yegor256/loog) [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/) @@ -15,11 +15,11 @@ [`Logger`](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html). First, install it: ```bash -$ gem install loog +gem install loog ``` Then, use it like this: ```ruby @@ -29,23 +29,24 @@ The gem is basically a provider of a few pre-configured loggers, which you can use for production (`Loog::REGULAR`) or for testing (`Loog::VERBOSE`). You can also shut it up with `Loog::NULL`. -There is also `Loog::Buffer` class that you can use for testing. +There is also `Loog::Buffer` class that you can use for testing. It accumulates all log calls and then returns the entire output through the `to_s()` method. ## How to contribute -Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html). +Read +[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html). Make sure you build is green before you contribute -your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and +your pull request. You will need to have +[Ruby](https://www.ruby-lang.org/en/) 2.3+ and [Bundler](https://bundler.io/) installed. Then: +```bash +bundle update +bundle exec rake ``` -$ bundle update -$ bundle exec rake -``` If it's clean and you don't see any error messages, submit your pull request. -