README.md in skunk-0.3.2 vs README.md in skunk-0.4.0

- old
+ new

@@ -1,15 +1,15 @@ # Skunk -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md) [![Build Status](https://travis-ci.org/fastruby/skunk.svg?branch=master)](https://travis-ci.org/fastruby/skunk) [![Maintainability](https://api.codeclimate.com/v1/badges/3e33d701ced16eee2420/maintainability)](https://codeclimate.com/github/fastruby/skunk/maintainability) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md) [![Build Status](https://travis-ci.org/fastruby/skunk.svg?branch=master)](https://travis-ci.org/fastruby/skunk) [![Maintainability](https://api.codeclimate.com/v1/badges/3e33d701ced16eee2420/maintainability)](https://codeclimate.com/github/fastruby/skunk/maintainability) [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/skunk) A RubyCritic extension to calculate StinkScore for a file or project. ## What is the StinkScore? -The StinkScore is a value that assesses the quality of a module. It takes into -account: +The StinkScore is a value that assesses the technical debt of a module. It takes +into account: - Code Complexity - Code Smells - Code Coverage @@ -17,11 +17,11 @@ refactoring adventure. It will help you answer these questions: - What can I do to pay off technical debt? - What are the most complicated files with the least code coverage? - What are good candidates for your next test-writing efforts? -- What are good candidates for your nest refactoring efforts? +- What are good candidates for your next refactoring efforts? The formula is not perfect and it is certainly controversial, so any feedback is welcome as a new issue! ## Installation @@ -40,10 +40,22 @@ $ gem install skunk ## Usage +### Help details + +There are not that many options but here they are: + +``` +skunk -h +Usage: skunk [options] [paths] + -b, --branch BRANCH Set branch to compare + -v, --version Show gem's version + -h, --help Show this message +``` + ### Getting a sorted list of stinkiest files To get the best results, make sure that you have `coverage/.resultset.json` in your application directory. That way `skunk` knows what's the status of your test suite + code coverage. @@ -56,12 +68,9 @@ Then get a list of stinky files: ``` $ skunk -warning: parser/current is loading parser/ruby26, which recognizes -warning: 2.6.5-compliant syntax, but you are running 2.6.2. -warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri. running flay smells running flog smells ............. running reek smells