Skip to content

Commit

Permalink
Add a little paragraph on “why”
Browse files Browse the repository at this point in the history
  • Loading branch information
blakeembrey committed Sep 17, 2015
1 parent 13dcc34 commit 3f1d2f9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

Return a pluralized or singularized word based on the input string.
> Pluralize and singularize any word.
## Installation

Expand Down Expand Up @@ -34,6 +34,10 @@ define(function (require, exports, module) {
<script src="pluralize.js"></script>
```

## Why?

This module uses a pre-defined list of rules, applied in order, to singularize or pluralize a given word. There are many cases where this is useful, such as any automation based on user input. For applications where the word(s) are known ahead of time, you can use a simple ternary (or function) which would be a much lighter alternative.

## Usage

```javascript
Expand Down

0 comments on commit 3f1d2f9

Please sign in to comment.