@@ -4,15 +4,12 @@ Normalize a word for easier comparison, useful for [NLCST][nlcst]
44
55## Installation
66
7- [ npm] [ npm-install ] :
7+ [ npm] [ ] :
88
99``` bash
1010npm install nlcst-normalize
1111```
1212
13- ** nlcst-normalize** is also available for [ duo] [ duo-install ] , and as an
14- AMD, CommonJS, and globals module, [ uncompressed and compressed] [ releases ] .
15-
1613## Usage
1714
1815``` js
@@ -38,23 +35,23 @@ normalize({
3835### ` normalize(value[, options]) `
3936
4037Normalize a word (often a node) for easier comparison. Always
41- normalises smart apostrophes (` ’ ` ) to dumb apostrophes (` ' ` ).
38+ normalises smart apostrophes (` ’ ` ) to straight apostrophes (` ' ` ).
4239And, lowercases alphabetical characters (` [A-Z] ` ).
4340
44- ** Parameters**
41+ ###### Parameters
4542
4643* ` value ` ([ ` Node ` ] [ nlcst-node ] , ` Array.<Node> ` , or ` string ` )
4744 — Value to normalize;
48-
4945* ` options ` (` Object? ` ):
5046
5147 * ` allowApostrophes ` (` boolean ` , default: ` false ` )
5248 — Do not strip apostrophes (` ' ` );
53-
5449 * ` allowDashes ` (` boolean ` , default: ` false ` )
5550 — Do not strip hyphens (` - ` ).
5651
57- ** Returns** : ` string ` — Normalized value.
52+ ###### Returns
53+
54+ ` string ` — Normalized value.
5855
5956## License
6057
@@ -70,11 +67,7 @@ And, lowercases alphabetical characters (`[A-Z]`).
7067
7168[ codecov ] : https://codecov.io/github/wooorm/nlcst-normalize
7269
73- [ npm-install ] : https://docs.npmjs.com/cli/install
74-
75- [ duo-install ] : http://duojs.org/#getting-started
76-
77- [ releases ] : https://github.com/wooorm/nlcst-normalize/releases
70+ [ npm ] : https://docs.npmjs.com/cli/install
7871
7972[ license ] : LICENSE
8073
0 commit comments