vendor/github.com/rickb777/plural/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# plural - Simple Go API for Pluralisation.

[![GoDoc](https://img.shields.io/badge/api-Godoc-blue.svg?style=flat-square)](https://godoc.org/github.com/rickb777/plural)
[![Build Status](https://travis-ci.org/rickb777/plural.svg?branch=master)](https://travis-ci.org/rickb777/plural)
[![Coverage Status](https://coveralls.io/repos/github/rickb777/plural/badge.svg?branch=master&service=github)](https://coveralls.io/github/rickb777/plural?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/rickb777/plural)](https://goreportcard.com/report/github.com/rickb777/plural)
[![Issues](https://img.shields.io/github/issues/rickb777/plural.svg)](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.