diff --git a/README.md b/README.md index f89636f..6f1bea5 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,9 @@ A bunch of utility functions that work with number in Vietnamese language ## Features +- Zero dependencies +- Edge runtime built-in support + +## Functions + - Read Vietnamese Number diff --git a/deno.json b/deno.json index 9876295..3d9d70e 100644 --- a/deno.json +++ b/deno.json @@ -1,10 +1,10 @@ { "name": "@hckhanh/vn-number", - "version": "1.1.4", + "version": "1.1.5", "exports": "./src/index.ts", "exclude": [ ".github/", - "tests/", + "src/**/*.test.ts", ".git*", ".prettier*", ".*ignore", diff --git a/src/read/index.ts b/src/read/index.ts index 7b6748d..ef61818 100644 --- a/src/read/index.ts +++ b/src/read/index.ts @@ -1,11 +1,8 @@ import NumberReader from './NumberReader.ts' /** - * This is a helper that convert a number to a string like the way a real Vietnamese. It comes with features: - * - * - Zero dependencies - * - Edge runtime built-in support - * - Unlimited value (use {@link string} for number bigger than {@link bigint}) + * This is a helper that convert a number to a string like the way a real Vietnamese. + * It can be used with unlimited value (use {@link string} for number bigger than {@link bigint}) * * @example * ```ts @@ -15,8 +12,8 @@ import NumberReader from './NumberReader.ts' * // output: mười chín triệu chín trăm chín mươi nghìn * ``` * - * @param number the number to read. It can be string or number type - * @return the Vietnamese number in string. + * @param number The number to read. It can be string, number or bigint value + * @return The Vietnamese number in string. */ export function readVnNumber(number: string | number | bigint): string { return NumberReader.read(number)