aboutsummaryrefslogtreecommitdiff
path: root/node_modules/irregular-plurals/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/irregular-plurals/readme.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
add node_modules to address #4364
Diffstat (limited to 'node_modules/irregular-plurals/readme.md')
-rw-r--r--node_modules/irregular-plurals/readme.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/node_modules/irregular-plurals/readme.md b/node_modules/irregular-plurals/readme.md
new file mode 100644
index 000000000..a700d630e
--- /dev/null
+++ b/node_modules/irregular-plurals/readme.md
@@ -0,0 +1,46 @@
+# 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
+>
+> 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.*
+
+
+## Install
+
+```
+$ npm install --save irregular-plurals
+```
+
+
+## Usage
+
+```js
+const irregularPlurals = require('irregular-plurals');
+
+console.log(irregularPlurals['cactus']);
+//=> 'cacti'
+
+console.log(irregularPlurals);
+/*
+ {
+ addendum: 'addenda',
+ alga: 'algae',
+ ...
+ }
+*/
+```
+
+
+## Related
+
+- [plur](https://github.com/sindresorhus/plur) - Pluralize a word
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)