quantible 0.3.1 → 0.3.3

package/README.md

@@ -19,38 +19,49 @@
 
 ## Examples
 
-Quantible excels at transforming various numerical expressions into their spoken word equivalents:
-
-- `5 - 10`  ->  "five minus ten"
-- `-5 + 10` ->  "negative five plus ten"
-- `10m/s`  ->  "ten meters per second"
-- `15m/s²` ->  "fifteen meters per second squared"
-- `15²` or `15^2` ->  "fifteen to the power of two"
-- `2^2m^2` ->  "two to the power of two meters squared"
-- `2^2m²` ->  "two to the power of two square meters"
-- `5E-10` ->  "five times ten to the power of negative ten"
-- `-5E10` ->  "negative five times ten to the power of ten"
-- `5E10`  ->  "five times ten to the power of ten"
-- `5 USD` ->  "five dollars"
-- `$5`   ->  "five dollars"
-- `5.25 USD` ->  "five dollars and twenty-five cents"
-- `$5.25`  ->  "five dollars and twenty-five cents"
-- `1000 ₩` ->  "one thousand won"
-- `v2`    ->  "v two"
-- `_5`    ->  "underscore five"
-- `A & B`  ->  "A and B"
-- `e.g.`   ->  "example given"
-
+Quantible handles a wide spectrum of numerical and symbolic expressions, converting them into natural, spoken-word English.
+
+### 🔢 Numbers, Decimals & Math
+- `123` -> "one hundred twenty-three"
+- `1.5` -> "one point five"
+- `5 - 10` -> "five minus ten"
+- `-5 + 10` -> "negative five plus ten"
+- `1,234,567` -> "one million two hundred thirty-four thousand five hundred sixty-seven"
+
+### 💰 Currencies (Symbol & Code)
+- `$1,000` -> "one thousand dollars"
+- `€50.00` -> "fifty euros"
+- `100 ₩` -> "one hundred won"
+- `123.45 USD` -> "one hundred twenty-three dollars and forty-five cents"
+- `$1.5` -> "one dollar and fifty cents" (Smart padding)
+
+### 📏 Units & Scientific Notation
+- `10m/s` -> "ten meters per second"
+- `15m/s²` -> "fifteen meters per second squared"
+- `5E-10` -> "five times ten to the power of negative ten"
+- `1.23e-4 mol·L⁻¹·s⁻¹` -> "one point twenty-three times ten to the power of negative four moles per liter per second"
+
+### 🏷️ Versioning & Identifiers
+- `v2` -> "v two"
+- `v3.2.1` -> "v three point two point one"
+- `_5` -> "underscore five"
+- `file_name_v2` -> "file underscore name underscore v two"
+
+### 🔣 Abbreviations & Symbols (Normalization)
+- `A & B` -> "A and B"
+- `e.g.` -> "example given"
+- `i.e.` -> "that is"
+- `test@example.com` -> "test at example dot com" (Email normalization)
+- `www.hello.com` -> "double you double you double you dot hello dot com" (Website normalization)
+- `Item #1` -> "Item hash one"
 
 The `autoReplaceAllMatches` function demonstrates the power of Quantible by converting all quantities within a text:
 
 **Input Sentence:**
-
-> "We made $500 more this year than last years projections of 25%"
+> "The new SSD offers 2TB capacity, costs $199.99, and runs at 5,400 RPM."
 
 **Output Sentence (after `autoReplaceAllMatches`):**
-
-> "We made five hundred dollars more this year than last years projections of twenty-five percent"
+> "The new SSD offers two terabytes capacity, costs one hundred ninety-nine dollars and ninety-nine cents, and runs at five thousand four hundred revolutions per minute."
 
 ## Installation
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "quantible",
   "description": "A versatile library for extracting and converting numerical values, units, currency, and mathematical expressions into their spoken word equivalents.",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",