gpincheiraa/number2words

View on GitHub
readme.md

Summary

Maintainability
Test Coverage
## Number2Words

[travis-image]: https://travis-ci.org/gpincheiraa/number2words.png
[travis-url]: https://travis-ci.org/gpincheiraa/number2words

[codeclimate-image]: https://codeclimate.com/github/gpincheiraa/number2words/badges/gpa.svg
[codeclimate-url]: https://codeclimate.com/github/gpincheiraa/number2words

[codeclimate-coverage-image]: https://codeclimate.com/github/gpincheiraa/number2words/badges/coverage.svg
[codeclimate-coverage-url]: https://codeclimate.com/github/gpincheiraa/number2words/coverage

[![Build Status][travis-image]][travis-url] [![Code Climate][codeclimate-image]][codeclimate-url] [![Test Coverage][codeclimate-coverage-image]][codeclimate-coverage-url]

A library to convert a number input in words. Support multiple languages.

Requirements:
- node

## Contribute
- git clone https://github.com/gpincheiraa/number2words.git
- cd number2words
- npm install
- npm test

## to do features:
- Adding coverage istanbul report and code-climate coverage badge ✓
[https://goo.gl/fRwCAy](https://goo.gl/fRwCAy), [https://goo.gl/fKjMU2](https://goo.gl/fKjMU2)
- Adding support for your language ([understand the algorithm idea](docs/idea.md) )
- Languages exportable module for global configuration.
- Adding more gramatically corner-cases for the test suite.
- Adding a more solid testing suite.
- Improve readbility and [ciclomatic complexity](http://damienlepage.com/cyclomatic-complexity/)
- Create a Dockerfile for work using the ES6 Syntax
- Use es6 for development
- Generate a node version distribution and browserfied version to the browser