Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
molingyu committed Sep 4, 2024
1 parent 2169e25 commit 0cbf7f3
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
# i18n-format

**i18n-format** is a multi-language conversion library for formatting data, supporting singular-plural conversion,
natural language number and Arabic number conversion, date, etc.

## Features

- **word2number**: Conversion between natural language numbers and Arabic numbers, and also supports conversion of
numbers in different languages
- **plural**: Singular to plural conversion
- **date**: Natural language representation of dates and times

## i18n-format language support

| lang | word2number | plural | date |
|-------|:-----------:|:------:|:----:|
| en ||||
| zh_CN ||||
| zh_TW ||||
| ja ||||

## Building

- Install CMake
- Install Python
- Ensure CMake and Python are in the user PATH
- Visual Studio: run `build.bat` from the command prompt
- Otherwise: run `build.sh` from a bash shell
- Results are in the build sub-folder
- On Windows you can open i18n_format.sln

## Documentation

[Manual]()

## Contributing
I18n-format welcomes users of different languages to contribute relevant implementations of their own languages.

## License

i18n-format is developed by stark233 and I18n-format contributors the MIT license.

0 comments on commit 0cbf7f3

Please sign in to comment.