README.md in reek-4.0.2 vs README.md in reek-4.0.3
- old
+ new
@@ -1,12 +1,41 @@
![reek logo](logo/reek.text.png)
# Code smell detector for Ruby
-## Overview
+**Table of Contents**
+- [Overview](#overview)
+- [Quickstart](#quickstart)
+- [Example](#example)
+- [Supported rubies](#supported-rubies)
+- [Fixing Smell Warnings](#fixing-smell-warnings)
+- [Sources](#sources)
+- [Code smells](#code-smells)
+- [Configuration](#configuration)
+ - [Command-line interface](#command-line-interface)
+ - [Configuration file](#configuration-file)
+ - [Configuration loading](#configuration-loading)
+ - [Configuration options](#configuration-options)
+ - [Source code comments](#source-code-comments)
+ - [Generating a 'todo' list](#generating-a-todo-list)
+- [Usage](#usage)
+- [Developing Reek / Contributing](#developing-reek--contributing)
+- [Output formats](#output-formats)
+- [Working with Rails](#working-with-rails)
+- [Integrations](#integrations)
+ - [Editor integrations](#editor-integrations)
+ - [Projects that use or support us](#projects-that-use-or-support-us)
+ - [Misc](#misc)
+- [Brothers and sisters](#brothers-and-sisters)
+- [Contributors](#contributors)
+- [Additional resources](#additional-resources)
+ - [Miscellaneous](#miscellaneous)
+ - [More information](#more-information)
+## Overview
+
[![Build Status](https://secure.travis-ci.org/troessner/reek.svg?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
[![Gem Version](https://badge.fury.io/rb/reek.svg)](https://badge.fury.io/rb/reek)
[![Dependency Status](https://gemnasium.com/troessner/reek.png)](https://gemnasium.com/troessner/reek)
[![Inline docs](https://inch-ci.org/github/troessner/reek.png)](https://inch-ci.org/github/troessner/reek)
[![Code Climate](https://codeclimate.com/github/troessner/reek/badges/gpa.svg)](https://codeclimate.com/github/troessner/reek)
@@ -17,11 +46,11 @@
Reek is a tool that examines Ruby classes, modules and methods and reports any
[Code Smells](docs/Code-Smells.md) it finds.
For an excellent introduction to
[Code Smells](docs/Code-Smells.md) and Reek check out [this blog post](https://blog.codeship.com/how-to-find-ruby-code-smells-with-reek/)
-or [that one](https://troessner.wordpress.com/2016/01/01/the-latest-and-greatest-additions-to-reek/). There is also [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA) from the [RubyConf Portugal](http://rubyconf.pt/).
+or [that one](https://troessner.svbtle.com/the-latest-and-greatest-additions-to-reek). There is also [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA) from the [RubyConf Portugal](http://rubyconf.pt/).
Install it via rubygems:
```Bash
gem install reek
@@ -459,9 +488,10 @@
* [Vim plugin](https://github.com/rainerborene/vim-reek)
* [TextMate Bundle](https://github.com/peeyush1234/reek.tmbundle)
* [Atom plugin](https://atom.io/packages/linter-reek)
* [SublimeLinter plugin](https://packagecontrol.io/packages/SublimeLinter-contrib-reek)
+* [Emacs plugin](https://github.com/hanmoi-choi/reek-emacs)
### Projects that use or support us
* [overcommit](https://github.com/brigade/overcommit) - a Git commit hook manager with support for
Reek