aboutsummaryrefslogtreecommitdiff
path: root/perl/perl-Lingua-EN-Fathom/README
diff options
context:
space:
mode:
Diffstat (limited to 'perl/perl-Lingua-EN-Fathom/README')
-rw-r--r--perl/perl-Lingua-EN-Fathom/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/perl/perl-Lingua-EN-Fathom/README b/perl/perl-Lingua-EN-Fathom/README
new file mode 100644
index 0000000000000..69bcdf836a175
--- /dev/null
+++ b/perl/perl-Lingua-EN-Fathom/README
@@ -0,0 +1,14 @@
+perl-Lingua-En-Fathom
+
+This module analyses English text in either a string or file. Totals
+are then calculated for the number of characters, words, sentences,
+blank and non blank (text) lines and paragraphs.
+
+Three common readability statistics are also derived, the Fog, Flesch
+and Kincaid indices.
+
+All of these properties can be accessed through individual methods,
+or by generating a text report.
+
+A hash of all unique words and the number of times they occur is
+generated.