Merge branch 'master' of https://github.com/cdimascio/py-readability-metrics

Author: Carmine DiMascio

README.md

@@ -2,7 +2,7 @@
 
 ![Travis Build](https://travis-ci.org/cdimascio/py-readability-metrics.svg?branch=master) ![Python](https://img.shields.io/badge/python-%203.4%20%7C%203.5%20%7C%203.6-blue.svg) [![MIT license](https://img.shields.io/badge/License-MIT-green.svg)](https://lbesson.mit-license.org/)
 
-Score the _readability_ of text using popular readability metrics including: Flesch-Kincaid Grade Level, Flesch Reading Ease, Gunning Fog Index, Dale Chall Readability, Automated Readability Index (ARI), Linear Write, SMOG, and Gunning Fog
+Score the _readability_ of text using popular readability metrics including: [Flesch Kincaid Grade Level](#flesch-kincaid-grade-level), [Flesch Reading Ease](#flesch-reading-ease), [Gunning Fog Index](#gunning-fog), [Dale Chall Readability](#dale-chall-readability), [Automated Readability Index (ARI)](#automated-readability-index-ari), [Coleman Liau Index](#coleman-liau-index), [Linear Write](#linear-write), and [SMOG](#smog)
 
 <p align="center">
  <img src="https://raw.githubusercontent.com/cdimascio/py-readability-metrics/master/assets/py-readability-metrics.png" width="500"></>
@@ -29,11 +29,23 @@ r.coleman_liau()
 r.dale_chall()
 r.ari()
 r.linear_write()
+r.smog()
 ```
 
 **\*Note:** `text` must contain >= 100 words\*
 
-## Readability Metric Details
+## Supported Metrics
+
+- [Flesch Kincaid Grade Level](#flesch-kincaid-grade-level)
+- [Flesch Reading Ease](#flesch-reading-ease)
+- [Dale Chall Readability](#dale-chall-readability)
+- [Automated Readability Index (ARI)](#automated-readability-index-ari)
+- [Coleman Liau Index](#coleman-liau-index)
+- [Gunning Fog](#gunning-fog)
+- [SMOG](#smog)
+- [Linear Write](#linear-write)
+
+## Readability Metric Details and Properties
 
 All metrics provide a `score` attribute. See details below to capture additional detail per metric.
 
@@ -98,7 +110,7 @@ print(dc.score)
 print(dc.grade_levels)
 ```
 
-### Automated Readability Index
+### Automated Readability Index (ARI)
 
 Unlike the other indices, the ARI, along with the Coleman-Liau, relies on a factor of characters per word, instead of the usual syllables per word. ARI is widely used on all types of texts.
 
@@ -193,6 +205,10 @@ print(lw.grade_level)
 
 Contributions are welcome!
 
+## References
+
+- [Readability Formulas](http://readabilityformulas.com/)
+
 ## License
 
 [MIT](LICENSE)