ReadmeIndexBuilder (builder 5.4.1 API)

All Known Implementing Classes:

DefaultReadmeIndexBuilder
```
public interface ReadmeIndexBuilder
```
Creates the Rule Index for README.md in Markdown Format.

Author:

Paul Campbell (pcampbell@kemitix.net)

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  String build()
  Builds the Rule Index in Markdown Format.

- Method Detail
  - build
```
String build()
```
    Builds the Rule Index in Markdown Format.
    
    Returns:
    
    The rule index.