From e0e4632b5fd3a08dbaf973bbebcf23a3b536681b Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Tue, 1 Jan 2019 17:04:28 -0500 Subject: [PATCH 1/5] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 767b480..55e6d4e 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ r.coleman_liau() r.dale_chall() r.ari() r.linear_write() +r.smog() ``` **\*Note:** `text` must contain >= 100 words\* From 8054a66fce9680c1dd9bcc9c9d3b51cce464052e Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Tue, 1 Jan 2019 17:24:53 -0500 Subject: [PATCH 2/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 55e6d4e..88d9f09 100644 --- a/README.md +++ b/README.md @@ -194,6 +194,10 @@ print(lw.grade_level) Contributions are welcome! +## References + +- [Readability Formulas](http://readabilityformulas.com/) + ## License [MIT](LICENSE) From c9014ba91963deb50a2c548c4792cdaa299da47e Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Tue, 1 Jan 2019 17:31:47 -0500 Subject: [PATCH 3/5] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 88d9f09..2dc1a4e 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,17 @@ r.smog() **\*Note:** `text` must contain >= 100 words\* +## 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 All metrics provide a `score` attribute. See details below to capture additional detail per metric. @@ -99,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. From 2f4d9f08d6cde189f92a6bf7772762f022bad290 Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Tue, 1 Jan 2019 17:32:38 -0500 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2dc1a4e..8541b57 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ r.smog() - [SMOG](#smog) - [Linear Write](#linear-write) -## Readability Metric Details +## Readability Metric Details and Properties All metrics provide a `score` attribute. See details below to capture additional detail per metric. From b086bd860db68ed0151cbf9f8c1dc06ac25e0a15 Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Tue, 1 Jan 2019 17:34:41 -0500 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8541b57..3ae45d1 100644 --- a/README.md +++ b/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)