Refactor prose

Author: wooorm

readme.md

@@ -1,21 +1,29 @@
-# retext-keywords [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
+# retext-keywords
 
-Keyword extraction with [**retext**][retext].
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
 
-## Installation
+[**retext**][retext] plugin to extract keywords and key-phrases.
+
+## Install
 
 [npm][]:
 
-```bash
+```sh
 npm install retext-keywords
 ```
 
-## Usage
+## Use
 
 Say we have the following file, `example.txt`, with the first four paragraphs
 on [Term Extraction][term-extraction] from Wikipedia:
 
-```text
+```txt
 Terminology mining, term extraction, term recognition, or glossary extraction, is a subtask of information extraction. The goal of terminology extraction is to automatically extract relevant terms from a given corpus.
 
 In the semantic web era, a growing number of communities and networked enterprises started to access and interoperate through the internet. Modeling these communities and their information needs is important for several web applications, like topic-driven web crawlers, web services, recommender systems, etc. The development of terminology extraction is essential to the language industry.
@@ -25,9 +33,9 @@ One of the first steps to model the knowledge domain of a virtual community is t
 Typically, approaches to automatic term extraction make use of linguistic processors (part of speech tagging, phrase chunking) to extract terminological candidates, i.e. syntactically plausible terminological noun phrases, NPs (e.g. compounds "credit card", adjective-NPs "local tourist information office", and prepositional-NPs "board of directors" - in English, the first two constructs are the most frequent). Terminological entries are then filtered from the candidate list using statistical and machine learning methods. Once filtered, because of their low ambiguity and high specificity, these terms are particularly useful for conceptualizing a knowledge domain or for supporting the creation of a domain ontology. Furthermore, terminology extraction is a very useful starting point for semantic similarity, knowledge management, human translation and machine translation, etc.
 ```
 
-And our script, `example.js`, looks as follows:
+…and our script, `example.js`, looks as follows:
 
-```javascript
+```js
 var vfile = require('to-vfile')
 var retext = require('retext')
 var keywords = require('retext-keywords')
@@ -58,7 +66,7 @@ function done(err, file) {
 
 Now, running `node example` yields:
 
-```text
+```txt
 Keywords:
 term
 extraction
@@ -80,8 +88,9 @@ communities
 
 Extract keywords and key-phrases from the document.
 
-The results are stored on `file.data`: keywords at `file.data.keywords`
-and key-phrases at `file.data.keyphrases`.  Both are lists.
+The results are stored on `file.data`: keywords at `file.data.keywords` and
+key-phrases at `file.data.keyphrases`.
+Both are lists.
 
 A single keyword looks as follows:
 
@@ -97,7 +106,7 @@ A single keyword looks as follows:
 }
 ```
 
-...and a key-phrase:
+…and a key-phrase:
 
 ```js
 {
@@ -112,22 +121,23 @@ A single keyword looks as follows:
 }
 ```
 
-###### `options`
+###### `options.maximum`
 
-*   `maximum` (default: `5`) — Try to detect `words` and `phrases`
-    words;
+Try to detect at most `maximum` `words` and `phrases` (`number`, default: `5`).
 
-    Note that actual counts may differ.  For example, when two words
-    have the same score, both will be returned.  Or when too few words
-    exist, less will be returned. the same goes for phrases.
+Note that actual counts may differ.
+For example, when two words have the same score, both will be returned.
+Or when too few words exist, less will be returned. the same goes for phrases.
 
 ## Contribute
 
-See [`contributing.md` in `retextjs/retext`][contributing] for ways to get
-started.
+See [`contributing.md`][contributing] in [`retextjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
 
-This organisation has a [Code of Conduct][coc].  By interacting with this
-repository, organisation, or community you agree to abide by its terms.
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
 
 ## License
 
@@ -147,20 +157,34 @@ repository, organisation, or community you agree to abide by its terms.
 
 [downloads]: https://www.npmjs.com/package/retext-keywords
 
+[size-badge]: https://img.shields.io/bundlephobia/minzip/retext-keywords.svg
+
+[size]: https://bundlephobia.com/result?p=retext-keywords
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
 [chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
 
 [chat]: https://spectrum.chat/unified/retext
 
 [npm]: https://docs.npmjs.com/cli/install
 
+[health]: https://github.com/retextjs/.github
+
+[contributing]: https://github.com/retextjs/.github/blob/master/contributing.md
+
+[support]: https://github.com/retextjs/.github/blob/master/support.md
+
+[coc]: https://github.com/retextjs/.github/blob/master/code-of-conduct.md
+
 [license]: license
 
 [author]: https://wooorm.com
 
 [retext]: https://github.com/retextjs/retext
 
 [term-extraction]: https://en.wikipedia.org/wiki/Terminology_extraction
-
-[contributing]: https://github.com/retextjs/retext/blob/master/contributing.md
-
-[coc]: https://github.com/retextjs/retext/blob/master/code-of-conduct.md