README.md in massa-0.0.8 vs README.md in massa-0.0.9

- old
+ new

@@ -3,13 +3,23 @@ [![Gem Version](https://badge.fury.io/rb/massa.svg)](https://rubygems.org/gems/massa) [![Build Status](https://travis-ci.org/lucascaton/massa.svg?branch=master)](https://travis-ci.org/lucascaton/massa) [![Coverage Status](https://img.shields.io/codeclimate/coverage/github/lucascaton/massa.svg)](https://codeclimate.com/github/lucascaton/massa) [![Code Climate](https://codeclimate.com/github/lucascaton/massa/badges/gpa.svg)](https://codeclimate.com/github/lucascaton/massa) -It's common to see Rails projects becomming hard to maintain and less fun after a while. +It's common to see Ruby (and Rails) projects becomming hard to maintain and less fun after a while. This gem helps you to keep its quality, good practices and security. +**Massa** can run in your CI and it will run different code analyzers tools, instead of only running your automated tests. + +You can either use only the [default tools](https://github.com/lucascaton/massa/blob/master/config/default_tools.yml) or adding custom ones by using a [simple config file](https://github.com/lucascaton/massa#usage). + +![massa](https://raw.githubusercontent.com/lucascaton/massa/master/readme/massa.gif) + +Verbose mode: + +![massa-v](https://raw.githubusercontent.com/lucascaton/massa/master/readme/massa-v.gif) + ## Installation Add the following lines to your application's Gemfile: ```ruby @@ -20,23 +30,27 @@ And then execute: $ bundle -## About the gem name - -"Massa" is a Portuguese slang which means "awesome", -so once you add it to your project, it becomes "massa"! - ## Usage Create a configuration file: $ ... # TODO -Then, run (or, ideally, add it to your CI config): +Then, run $ bundle exec massa + +It's recommended to use `-V` (or `--verbose`) flag when running it in a CI: + + $ bundle exec massa -V + +## About the gem name + +"Massa" is a Portuguese slang which means "awesome", +so once you add it to your project, it becomes "massa"! ## Contributing [Bug reports](https://github.com/lucascaton/massa/issues) and [pull requests](https://github.com/lucascaton/massa/pulls) are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.