Skip to content

Commit

Permalink
Update readme file (#165)
Browse files Browse the repository at this point in the history
  • Loading branch information
@kwn
kwn authored Dec 4, 2023
1 parent b9b998b commit cfab3d8
Showing 1 changed file with 42 additions and 41 deletions.
83 changes: 42 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Test Coverage](https://codeclimate.com/github/kwn/number-to-words/badges/coverage.svg)](https://codeclimate.com/github/kwn/number-to-words/coverage)
[![Latest Stable Version](https://poser.pugx.org/kwn/number-to-words/v/stable)](https://packagist.org/packages/kwn/number-to-words)

This library converts numbers to their word representation (123 -> one hundred twenty three).
Welcome to `number-to-words`, a PHP utility that seamlessly transforms numeric values into their corresponding words. Effortlessly convert numbers, such as 123, into expressive and readable formats like "one hundred and twenty-three" with just a few lines of code.

## Installation

Expand Down Expand Up @@ -71,50 +71,51 @@ It can be also used with a static method:
NumberToWords::transformCurrency('en', 5099, 'USD'); // outputs "fifty dollars ninety nine cents"
```

Please keep in mind, the currency transformer accepts integers as the amount to transform. It means that if you store amounts as floats (e.g. 4.99) you need to multiply them by 100 and pass the integer (499) as an argument.
Note: The Currency Transformer within this library processes integers; ensure your input amounts are in whole numbers by multiplying any float values by 100 before transformation. For instance, transform 45.67 by using 4567 as the input for accurate currency conversion.

## Available locale

| Language | Identifier | Number | Currency |
| -------------------- | ---------- | ------ | -------- |
| Albanian | al | + | + |
| Arabic | ar | + | + |
| Azerbaijani | az | + | + |
| Belgian French | fr_BE | + | - |
| Brazilian Portuguese | pt_BR | + | + |
| Bulgarian | bg | + | - |
| Czech | cs | + | - |
| Danish | dk | + | + |
| Dutch | nl | + | - |
| English | en | + | + |
| Estonian | et | + | - |
| Georgian | ka | + | + |
| German | de | + | + |
| French | fr | + | + |
| Hungarian | hu | + | + |
| Indonesian | id | + | + |
| Italian | it | + | - |
| Kurdish | ku | + | - |
| Lithuanian | lt | + | + |
| Latvian | lv | + | + |
| Macedonian | mk | + | - |
| Malay | ms | + | + |
| Persian | fa | + | - |
| Polish | pl | + | + |
| Romanian | ro | + | + |
| Serbian | sr | + | + |
| Slovak | sk | + | + |
| Spanish | es | + | + |
| Russian | ru | + | + |
| Swedish | sv | + | - |
| Turkish | tr | + | + |
| Turkmen | tk | + | + |
| Ukrainian | ua | + | + |
| Yoruba | yo | + | + |
|----------------------|-----------| ------ | -------- |
| Albanian | al | + | + |
| Arabic | ar | + | + |
| Azerbaijani | az | + | + |
| Belgian French | fr_BE | + | - |
| Brazilian Portuguese | pt_BR | + | + |
| Bulgarian | bg | + | - |
| Czech | cs | + | - |
| Danish | dk | + | + |
| Dutch | nl | + | - |
| English | en | + | + |
| Estonian | et | + | - |
| Georgian | ka | + | + |
| German | de | + | + |
| French | fr | + | + |
| Hungarian | hu | + | + |
| Indonesian | id | + | + |
| Italian | it | + | - |
| Kurdish | ku | + | - |
| Lithuanian | lt | + | + |
| Latvian | lv | + | + |
| Macedonian | mk | + | - |
| Malay | ms | + | + |
| Persian | fa | + | - |
| Polish | pl | + | + |
| Romanian | ro | + | + |
| Serbian | sr | + | + |
| Slovak | sk | + | + |
| Spanish | es | + | + |
| Russian | ru | + | + |
| Swedish | sv | + | - |
| Turkish | tr | + | + |
| Turkmen | tk | + | + |
| Ukrainian | ua | + | + |
| Uzbek | uz | + | + |
| Yoruba | yo | + | + |

## Contributors

Many transformers were ported from the `pear/Numbers_Words` library. Some of them were created from scratch by [contributors](https://github.com/kwn/number-to-words/graphs/contributors). Thank you!
Some transformers were ported from the `pear/Numbers_Words` library. Others were created by [contributors](https://github.com/kwn/number-to-words/graphs/contributors). Thank you!

## Version 2.x - BC and major changes

Expand All @@ -124,10 +125,10 @@ Many transformers were ported from the `pear/Numbers_Words` library. Some of the

## Questions and answers

**Q: I found a bug. What should I do?**
**Q: What should I do if I encounter a bug while using the library?**

A: Please report an issue on GitHub. Feel free to fix it and open a pull request. I don't know most of those languages that the library supports, so your help and contribution would be much appreciated. Thanks!
A: If you come across a bug, please open an issue on our GitHub repository. As I may not be proficient in all languages, we encourage users to submit fixes and collaborate to enhance the library's functionality.

**Q: My language is missing. Could it be added?**

A: Unfortunately, there's a high chance I don't know your language. Feel free to implement the missing transformer and open a pull request. You can take a look at the existing transformers, and follow the same pattern as other languages do.
A: There's a high chance I don't know your language. Feel free to implement the missing language and open a pull request. You can use the existing languages as a reference.

0 comments on commit cfab3d8

Please sign in to comment.