urdu-text-utils 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.3
4
+
5
+ - Significantly expand transliteration dictionary coverage across pronouns & oblique forms (`مجھے`, `ہمیں`, `انہیں`, `اسے`, `جسے`), everyday verbs and inflections, calendar & weekdays, numbers & ordinals, food, household objects, health, geography, and common Pakistani names.
6
+ - Expanded Roman Urdu variants (`ROMAN_VARIANTS`) for common texting and phonetically ambiguous spellings (`mjhe`, `humein`, `unhein`, `isay`, `chahye`, etc.).
7
+ - Enhanced dictionary normalization and clean token mapping for slug generation and reverse transliteration.
8
+
3
9
  ## 0.1.2
4
10
 
5
11
  - Dictionary grows to ~650 entries: news and public-life vocabulary (the densest register in Urdu media), technology, education, health, colours, animals, extended family, food and place names.
package/README.md CHANGED
@@ -1,9 +1,18 @@
1
1
  # urdu-text-utils
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/urdu-text-utils?style=flat-square&color=157f52&label=npm)](https://www.npmjs.com/package/urdu-text-utils)
4
+ [![CI](https://img.shields.io/github/actions/workflow/status/Zaid-maker/urdu-text-utils/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/Zaid-maker/urdu-text-utils/actions/workflows/ci.yml)
5
+ [![minzipped size](https://img.shields.io/bundlejs/size/urdu-text-utils?style=flat-square&label=min%2Bgzip)](https://bundlejs.com/?q=urdu-text-utils)
6
+ [![dependencies](https://img.shields.io/badge/dependencies-0-157f52?style=flat-square)](https://www.npmjs.com/package/urdu-text-utils?activeTab=dependencies)
7
+ [![downloads](https://img.shields.io/npm/dm/urdu-text-utils?style=flat-square)](https://www.npmjs.com/package/urdu-text-utils)
8
+ [![license](https://img.shields.io/npm/l/urdu-text-utils?style=flat-square)](./LICENSE)
9
+
3
10
  Urdu text processing toolkit for JavaScript and TypeScript. Normalization, detection, digits, diacritics, collation, search, statistics and transliteration.
4
11
 
5
12
  Zero runtime dependencies. ESM + CJS. Ships its own types.
6
13
 
14
+ **[Documentation and live playground →](https://zaid-maker.github.io/urdu-text-utils/)**
15
+
7
16
  ```bash
8
17
  npm install urdu-text-utils
9
18
  ```
@@ -182,6 +191,18 @@ npm run typecheck
182
191
  npm run build
183
192
  ```
184
193
 
194
+ ### Docs site
195
+
196
+ The site is VitePress, in `docs/`. Its playground imports the library from `src/` through a Vite alias, so the examples can never drift from the code.
197
+
198
+ ```bash
199
+ npm run docs:dev # local server with hot reload
200
+ npm run docs:build # static output in docs/.vitepress/dist
201
+ npm run docs:preview
202
+ ```
203
+
204
+ CI builds the docs on every push. VitePress fails on dead links, so a renamed page breaks the build rather than shipping a 404.
205
+
185
206
  ## Releasing
186
207
 
187
208
  Publishing is automated and tag-driven. CI runs tests on Node 18/20/22 for every push and PR; nothing reaches npm until a version tag exists.