README.md

Readability

This repository contains a Vale-compatible implementation of many popular "readability" metrics.

Getting Started

❗ Readability requires Vale >= 2.13.0. ❗

Download the latest release, copy the "Readability" directory to your StylesPath, and include it in your configuration file:

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = Readability

See Usage for more information.