diff options
Diffstat (limited to 'vendor/github.com/rickb777/plural/README.md')
| -rw-r--r-- | vendor/github.com/rickb777/plural/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/github.com/rickb777/plural/README.md b/vendor/github.com/rickb777/plural/README.md new file mode 100644 index 00000000..b73bc256 --- /dev/null +++ b/vendor/github.com/rickb777/plural/README.md @@ -0,0 +1,28 @@ +# plural - Simple Go API for Pluralisation. + +[](https://godoc.org/github.com/rickb777/plural) +[](https://travis-ci.org/rickb777/plural) +[](https://coveralls.io/github/rickb777/plural?branch=master) +[](https://goreportcard.com/report/github.com/rickb777/plural) +[](https://github.com/rickb777/plural/issues) + +Package plural provides simple support for localising plurals in a flexible range of different styles. + +There are considerable differences around the world in the way plurals are handled. This is a simple +but competent API for catering with these differences when presenting to people formatted text with numbers. + +This package is able to format **countable things** and **continuous values**. It can handle integers +and floating point numbers equally and this allows you to decide to what extent each is appropriate. + +For example, `2 cars` might weigh `1.6 tonnes`; both categories are covered. + +This API is deliberately simple; it doesn't address the full gamut of internationalisation. If that's +what you need, you should consider products such as https://github.com/nicksnyder/go-i18n instead. + +## Installation + + go get -u github.com/rickb777/plural + +## Status + +This library has been in reliable production use for some time. Versioning follows the well-known semantic version pattern. |