+10
-10
| { | ||
| "name": "flesch", | ||
| "version": "1.0.3", | ||
| "version": "1.0.4", | ||
| "description": "Formula to detect the ease of reading a text according to Flesch Reading Ease (1975)", | ||
@@ -13,5 +13,5 @@ "license": "MIT", | ||
| "bugs": "https://github.com/words/flesch/issues", | ||
| "author": "Titus Wormer <tituswormer@gmail.com> (http://wooorm.com)", | ||
| "author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)", | ||
| "contributors": [ | ||
| "Titus Wormer <tituswormer@gmail.com> (http://wooorm.com)" | ||
| "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)" | ||
| ], | ||
@@ -24,10 +24,10 @@ "files": [ | ||
| "browserify": "^16.0.0", | ||
| "is-nan": "^1.2.1", | ||
| "nyc": "^13.0.0", | ||
| "prettier": "^1.14.2", | ||
| "remark-cli": "^5.0.0", | ||
| "remark-preset-wooorm": "^4.0.0", | ||
| "is-nan": "^1.0.0", | ||
| "nyc": "^14.0.0", | ||
| "prettier": "^1.0.0", | ||
| "remark-cli": "^6.0.0", | ||
| "remark-preset-wooorm": "^5.0.0", | ||
| "tape": "^4.0.0", | ||
| "tinyify": "^2.4.3", | ||
| "xo": "^0.22.0" | ||
| "tinyify": "^2.0.0", | ||
| "xo": "^0.24.0" | ||
| }, | ||
@@ -34,0 +34,0 @@ "scripts": { |
+27
-14
@@ -1,6 +0,11 @@ | ||
| # flesch [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov] | ||
| # flesch | ||
| Formula to detect the grade level of text according to the | ||
| [Flesch Reading Ease][formula]. | ||
| [![Build][build-badge]][build] | ||
| [![Coverage][coverage-badge]][coverage] | ||
| [![Downloads][downloads-badge]][downloads] | ||
| [![Size][size-badge]][size] | ||
| Formula to detect the grade level of text according to the [Flesch Reading | ||
| Ease][formula]. | ||
| See [syllable][] for detecting syllables. | ||
@@ -33,8 +38,8 @@ | ||
| Given an object containing the number of words (`word`), the number | ||
| of sentences (`sentence`), and the number of syllables (`syllable`) | ||
| in a document, returns the reading ease associated with the document. | ||
| Given an object containing the number of words (`word`), the number of sentences | ||
| (`sentence`), and the number of syllables (`syllable`) in a document, returns | ||
| the reading ease associated with the document. | ||
| Returned values are 120 (every sentence consisting of only two | ||
| one-syllable words), or lower (including negative values). | ||
| Returned values are 120 (every sentence consisting of only two one-syllable | ||
| words), or lower (including negative values). | ||
@@ -72,10 +77,18 @@ The values have the following semantics: | ||
| [travis-badge]: https://img.shields.io/travis/words/flesch.svg | ||
| [build-badge]: https://img.shields.io/travis/words/flesch.svg | ||
| [travis]: https://travis-ci.org/words/flesch | ||
| [build]: https://travis-ci.org/words/flesch | ||
| [codecov-badge]: https://img.shields.io/codecov/c/github/words/flesch.svg | ||
| [coverage-badge]: https://img.shields.io/codecov/c/github/words/flesch.svg | ||
| [codecov]: https://codecov.io/github/words/flesch | ||
| [coverage]: https://codecov.io/github/words/flesch | ||
| [downloads-badge]: https://img.shields.io/npm/dm/flesch.svg | ||
| [downloads]: https://www.npmjs.com/package/flesch | ||
| [size-badge]: https://img.shields.io/bundlephobia/minzip/flesch.svg | ||
| [size]: https://bundlephobia.com/result?p=flesch | ||
| [npm]: https://docs.npmjs.com/cli/install | ||
@@ -85,6 +98,6 @@ | ||
| [author]: http://wooorm.com | ||
| [author]: https://wooorm.com | ||
| [formula]: http://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests#Flesch_Reading_Ease | ||
| [formula]: https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests#Flesch_Reading_Ease | ||
| [syllable]: https://github.com/words/syllable |
6310
4.85%101
14.77%