aboutsummaryrefslogtreecommitdiff
path: root/node_modules/irregular-plurals/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-08-14 05:01:11 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-08-14 05:02:09 +0200
commit363723fc84f7b8477592e0105aeb331ec9a017af (patch)
tree29f92724f34131bac64d6a318dd7e30612e631c7 /node_modules/irregular-plurals/readme.md
parent5634e77ad96bfe1818f6b6ee70b7379652e5487f (diff)
node_modules
Diffstat (limited to 'node_modules/irregular-plurals/readme.md')
-rw-r--r--node_modules/irregular-plurals/readme.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/node_modules/irregular-plurals/readme.md b/node_modules/irregular-plurals/readme.md
index a700d630e..8dea5ca7a 100644
--- a/node_modules/irregular-plurals/readme.md
+++ b/node_modules/irregular-plurals/readme.md
@@ -1,19 +1,20 @@
# irregular-plurals [![Build Status](https://travis-ci.org/sindresorhus/irregular-plurals.svg?branch=master)](https://travis-ci.org/sindresorhus/irregular-plurals)
-> Map of nouns to their irregular plural form
->
+> Map of nouns to their irregular plural form
+
+
> An irregular plural in this library is defined as a noun that cannot be made plural by applying these rules:
> - If the noun ends in an "s", "x", "z", "ch" or "sh", add "es"
> - If the noun ends in a "y" and is preceded by a consonent, drop the "y" and add "ies"
> - If the noun ends in a "y" and is preceded by a vowel, add "s"
-*The list is just a [JSON file](irregular-plurals.json) and can be used wherever.*
+The list is just a [JSON file](irregular-plurals.json) and can be used wherever.
## Install
```
-$ npm install --save irregular-plurals
+$ npm install irregular-plurals
```
@@ -27,11 +28,11 @@ console.log(irregularPlurals['cactus']);
console.log(irregularPlurals);
/*
- {
- addendum: 'addenda',
- alga: 'algae',
- ...
- }
+{
+ addendum: 'addenda',
+ alga: 'algae',
+ …
+}
*/
```
@@ -43,4 +44,4 @@ console.log(irregularPlurals);
## License
-MIT © [Sindre Sorhus](http://sindresorhus.com)
+MIT © [Sindre Sorhus](https://sindresorhus.com)