Skip to content
This repository was archived by the owner on Dec 17, 2018. It is now read-only.

Commit 92aea80

Browse files
committed
Minor README fixes
1 parent e533056 commit 92aea80

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ parsed, and a second optional parameter `options`, an object with the following
88
possible keys:
99

1010
- `cardinal` and `ordinal` – Arrays of valid plural categories for the current
11-
locale, used to validate plural and selectordinal keys. If these are missing
12-
or set to false, the full set of valid [Unicode CLDR] keys is used: `'zero',
13-
'one', 'two', 'few', 'many', 'other'`. To disable this check, pass in an empty
14-
array.
11+
locale, used to validate `plural` and `selectordinal` keys. If these are
12+
missing or set to false, the full set of valid [Unicode CLDR] keys is used:
13+
`'zero', 'one', 'two', 'few', 'many', 'other'`. To disable this check, pass in
14+
an empty array.
1515

1616
- `strictFunctionParams` – By default, function parameters are split on commas
1717
and trimmed, so the parameters in `{x,fn, a, b }` are parsed as
@@ -27,7 +27,7 @@ possible keys:
2727
special character directly inside a `plural` or `selectordinal` statement.
2828
Outside those, `#` and `'#'` will be parsed as literal text.
2929

30-
The parser only supports the default `DOUBLE_OPTIONAL` apostrophe mode. A
30+
The parser only supports the default `DOUBLE_OPTIONAL` [apostrophe mode]. A
3131
single apostrophe only starts quoted literal text if preceded by a curly brace
3232
(`{}`) or a pound symbol (`#`) inside a `plural` or `selectordinal` statement,
3333
depending on the value of `strictNumberSign`. Otherwise, it is a literal
@@ -38,6 +38,7 @@ apostrophe. A double apostrophe is always a literal apostrophe.
3838
[parser.pegjs]: ./parser.pegjs
3939
[PEG.js]: http://pegjs.org/
4040
[Unicode CLDR]: http://cldr.unicode.org/index/cldr-spec/plural-rules
41+
[apostrophe mode]: http://www.icu-project.org/apiref/icu4c/messagepattern_8h.html#af6e0757e0eb81c980b01ee5d68a9978b
4142

4243

4344
#### Installation
@@ -103,6 +104,8 @@ npm install messageformat-parser
103104
// locale are `one`, `other`, and explicit keys like `=0`.
104105
```
105106

107+
For more example usage, please take a look at our [test suite](./test.js).
108+
106109
#### Contributor License Agreement
107110
See the [messageformat.js README][CLA] for details.
108111

0 commit comments

Comments
 (0)