Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sujamess committed Oct 14, 2021
1 parent 06ea306 commit ac45cd4
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# numconword

## What is numconword?
[numconword](https://github.com/sujamess/numconword) is a Go library for converting any type of numbers into readable words
- **numconword** prioritizes big number handling — You could convert numbers as big as you want

## Quick start
1. Installation
``` bash
go get -u github.com/sujamess/numconword
```
2. Let's convert!
``` bash
package main

import (
"fmt"

"github.com/sujamess/numconword"
)

func main() {
readableWords, err := numconword.ConvertFloat64(123456.78)
if err != nil {
// handle error
}

// one hundred twenty three thousand fifty six point seventy eight
fmt.Println(readableWords)
}
```
## Contribution
I'll really appreciate contributions! This library has a lot of things to work on (translation, performance improvement, add more test cases, etc.)

0 comments on commit ac45cd4

Please sign in to comment.