69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
# [numbro](https://numbrojs.com/)
|
|
|
|
[](https://www.npmjs.com/package/numbro)
|
|
|
|
A javascript library for formatting and manipulating numbers.
|
|
|
|
[Website and documentation](http://numbrojs.com)
|
|
|
|
|
|
# Travis Build Status
|
|
|
|
Master [](https://travis-ci.org/BenjaminVanRyseghem/numbro)
|
|
|
|
Develop [](https://travis-ci.org/BenjaminVanRyseghem/numbro)
|
|
|
|
# NPM
|
|
|
|
[](https://nodei.co/npm/numbro/)
|
|
|
|
# Contributing
|
|
|
|
Please submit all pull requests to the `develop` branch.
|
|
|
|
1. Fork the library
|
|
|
|
1. Run `npm install` to install dependencies
|
|
|
|
1. Add your tests to the files in `/tests`
|
|
|
|
1. To test your tests, run `npm test`
|
|
|
|
1. When all your tests are passing, submit a pull request to the `develop` branch.
|
|
|
|
|
|
### Languages
|
|
|
|
Language tags follow the [BCP 47](https://tools.ieft.org/html/bcp47) specification.
|
|
|
|
### Language translations will not be merged without unit tests.
|
|
|
|
See [the english unit tests](https://github.com/BenjaminVanRyseghem/numbro/blob/develop/tests/languages/en-GB-tests.js) for an example.
|
|
|
|
|
|
# Changelog
|
|
|
|
See [CHANGELOG.md](CHANGELOG.md). For the original project (Numeral.js) changelog, see [CHANGELOG-Numeraljs.md](CHANGELOG-Numeraljs.md).
|
|
|
|
|
|
# Acknowledgements
|
|
|
|
`numbro` is forked from [Adam Draper](https://github.com/adamwdraper)'s project
|
|
[Numeral.js](http://numeraljs.com/), which was in turn inspired by and heavily borrowed from
|
|
[Moment.js](http://momentjs.com).
|
|
|
|
|
|
# License
|
|
|
|
Copyright © 2017-2019 Benjamin Van Ryseghem
|
|
|
|
Copyright © 2015-2017 Företagsplatsen AB
|
|
|
|
Copyright © 2014 Adam Draper
|
|
|
|
---
|
|
|
|
Distributed under the MIT license. If you want to know more, see the `LICENSE` file.
|
|
|
|
The original license file for `Numeral.js` can be found in `LICENSE-Numeraljs`
|