From dc10f9217353d38558e1a27715b2313b2a83a84a Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sun, 19 Jan 2020 09:28:33 +0100 Subject: [PATCH] Refactor prose --- package.json | 15 +++++- readme.md | 137 ++++++++++++++++++++++++++------------------------- 2 files changed, 83 insertions(+), 69 deletions(-) diff --git a/package.json b/package.json index b24d941..864379c 100644 --- a/package.json +++ b/package.json @@ -65,8 +65,21 @@ "branches": 100 }, "remarkConfig": { + "settings": { + "paddedTable": false + }, "plugins": [ - "preset-wooorm" + "preset-wooorm", + [ + "toc", + { + "heading": "contents" + } + ], + [ + "lint-table-pipe-alignment", + false + ] ] } } diff --git a/readme.md b/readme.md index 98d40d9..8225174 100644 --- a/readme.md +++ b/readme.md @@ -13,26 +13,27 @@ header. Related to [`bcp-47`][bcp47]. -## Installation +## Contents -[npm][]: - -```bash -npm install bcp-47-match -``` - -## Table of Contents - -* [Usage](#usage) +* [Install](#install) +* [Use](#use) * [API](#api) * [match.basicFilter(tags\[, ranges\])](#matchbasicfiltertags-ranges) * [match.extendedFilter(tags\[, ranges\])](#matchextendedfiltertags-ranges) * [match.lookup(tags, ranges)](#matchlookuptags-ranges) * [License](#license) -## Usage +## Install + +[npm][]: + +```sh +npm install bcp-47-match +``` -```javascript +## Use + +```js var match = require('bcp-47-match') var basic = match.basicFilter @@ -74,25 +75,25 @@ Returns a list of matching tags in the order they matched.
View matching table -| Basic Filter | \* | de | de-CH | de-DE | de-\*-DE | \*-CH | -| --------------- | --- | --- | ----- | ----- | -------- | ----- | -| de | ✔︎ | ✔︎ | | | | | -| de-CH | ✔︎ | ✔︎ | ✔︎ | | | | -| de-CH-1996 | ✔︎ | ✔︎ | ✔︎ | | | | -| de-DE | ✔︎ | ✔︎ | | ✔︎ | | | -| de-DE-1996 | ✔︎ | ✔︎ | | ✔︎ | | | -| de-DE-x-goethe | ✔︎ | ✔︎ | | ✔︎ | | | -| de-Deva | ✔︎ | ✔︎ | | | | | -| de-Deva-DE | ✔︎ | ✔︎ | | | | | -| de-Latf-DE | ✔︎ | ✔︎ | | | | | -| de-Latn-DE | ✔︎ | ✔︎ | | | | | -| de-Latn-DE-1996 | ✔︎ | ✔︎ | | | | | -| de-x-DE | ✔︎ | ✔︎ | | | | | -| en | ✔︎ | | | | | | -| en-GB | ✔︎ | | | | | | -| zh | ✔︎ | | | | | | -| zh-Hans | ✔︎ | | | | | | -| zh-Hant | ✔︎ | | | | | | +| Basic Filter | \* | de | de-CH | de-DE | de-\*-DE | \*-CH | +| ------------ | --- | --- | ----- | ----- | -------- | ----- | +| de | ✔︎ | ✔︎ | | | | | +| de-CH | ✔︎ | ✔︎ | ✔︎ | | | | +| de-CH-1996 | ✔︎ | ✔︎ | ✔︎ | | | | +| de-DE | ✔︎ | ✔︎ | | ✔︎ | | | +| de-DE-1996 | ✔︎ | ✔︎ | | ✔︎ | | | +| de-DE-x-goethe | ✔︎ | ✔︎ | | ✔︎ | | | +| de-Deva | ✔︎ | ✔︎ | | | | | +| de-Deva-DE | ✔︎ | ✔︎ | | | | | +| de-Latf-DE | ✔︎ | ✔︎ | | | | | +| de-Latn-DE | ✔︎ | ✔︎ | | | | | +| de-Latn-DE-1996 | ✔︎ | ✔︎ | | | | | +| de-x-DE | ✔︎ | ✔︎ | | | | | +| en | ✔︎ | | | | | | +| en-GB | ✔︎ | | | | | | +| zh | ✔︎ | | | | | | +| zh-Hans | ✔︎ | | | | | | +| zh-Hant | ✔︎ | | | | | |
@@ -118,25 +119,25 @@ with further ranges.
View matching table -| Extended Filter | \* | de | de-CH | de-DE | de-\*-DE | \*-CH | +| Extended Filter | \* | de | de-CH | de-DE | de-\*-DE | \*-CH | | --------------- | --- | --- | ----- | ----- | -------- | ----- | -| de | ✔︎ | ✔︎ | | | | | -| de-CH | ✔︎ | ✔︎ | ✔︎ | | | ✔︎ | -| de-CH-1996 | ✔︎ | ✔︎ | ✔︎ | | | ✔︎ | -| de-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-DE-1996 | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-DE-x-goethe | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-Deva | ✔︎ | ✔︎ | | | | | -| de-Deva-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-Latf-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-Latn-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-Latn-DE-1996 | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | -| de-x-DE | ✔︎ | ✔︎ | | | | | -| en | ✔︎ | | | | | | -| en-GB | ✔︎ | | | | | | -| zh | ✔︎ | | | | | | -| zh-Hans | ✔︎ | | | | | | -| zh-Hant | ✔︎ | | | | | | +| de | ✔︎ | ✔︎ | | | | | +| de-CH | ✔︎ | ✔︎ | ✔︎ | | | ✔︎ | +| de-CH-1996 | ✔︎ | ✔︎ | ✔︎ | | | ✔︎ | +| de-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-DE-1996 | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-DE-x-goethe | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-Deva | ✔︎ | ✔︎ | | | | | +| de-Deva-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-Latf-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-Latn-DE | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-Latn-DE-1996 | ✔︎ | ✔︎ | | ✔︎ | ✔︎ | | +| de-x-DE | ✔︎ | ✔︎ | | | | | +| en | ✔︎ | | | | | | +| en-GB | ✔︎ | | | | | | +| zh | ✔︎ | | | | | | +| zh-Hans | ✔︎ | | | | | | +| zh-Hant | ✔︎ | | | | | |
@@ -163,25 +164,25 @@ Returns the first match, if any.
View matching table -| Lookup | \* | de | de-CH | de-DE | de-\*-DE | \*-CH | -| --------------- | --- | --- | ----- | ----- | -------- | ----- | -| de | | ✔︎︎ | ✔︎︎ | ✔︎ | ✔︎ | ✔︎ | -| de-CH | | | ✔︎ | | | ✔︎ | -| de-CH-1996 | | | | | | ✔︎ | -| de-DE | | | | ✔︎ | | ✔︎ | -| de-DE-1996 | | | | | | ✔︎ | -| de-DE-x-goethe | | | | | | ✔︎ | -| de-Deva | | | | | | ✔︎ | -| de-Deva-DE | | | | | | ✔︎ | -| de-Latf-DE | | | | | | ✔︎ | -| de-Latn-DE | | | | | | ✔︎ | -| de-Latn-DE-1996 | | | | | | ✔︎ | -| de-x-DE | | | | | | ✔︎ | -| en | | | | | | ✔︎ | -| en-GB | | | | | | ✔︎ | -| zh | | | | | | ✔︎ | -| zh-Hans | | | | | | ✔︎ | -| zh-Hant | | | | | | ✔︎ | +| Lookup | \* | de | de-CH | de-DE | de-\*-DE | \*-CH | +| ------ | --- | --- | ----- | ----- | -------- | ----- | +| de | | ✔︎︎ | ✔︎︎ | ✔︎ | ✔︎ | ✔︎ | +| de-CH | | | ✔︎ | | | ✔︎ | +| de-CH-1996 | | | | | | ✔︎ | +| de-DE | | | | ✔︎ | | ✔︎ | +| de-DE-1996 | | | | | | ✔︎ | +| de-DE-x-goethe | | | | | | ✔︎ | +| de-Deva | | | | | | ✔︎ | +| de-Deva-DE | | | | | | ✔︎ | +| de-Latf-DE | | | | | | ✔︎ | +| de-Latn-DE | | | | | | ✔︎ | +| de-Latn-DE-1996 | | | | | | ✔︎ | +| de-x-DE | | | | | | ✔︎ | +| en | | | | | | ✔︎ | +| en-GB | | | | | | ✔︎ | +| zh | | | | | | ✔︎ | +| zh-Hans | | | | | | ✔︎ | +| zh-Hant | | | | | | ✔︎ |