tamil-toolkit 0.0.0-stage → 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tamil-toolkit contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,30 @@
-# Temporary Holding Version
+# tamil-toolkit for TypeScript / WASM
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`just sync-bindings` produces Node and browser WASM builds and TypeScript
+declarations. Node: `import * as tamil from 'tamil-toolkit'`. Browser:
+`import { init, get_letters } from 'tamil-toolkit/web'; await init();`.
+The experimental MIT-licensed `0.1.0-alpha.1` is being prepared; no registry upload
+has occurred. Once published, install with `npm install tamil-toolkit@alpha`.
+These adapters serialize calls into the shared Rust dispatcher. Planned modules
+are excluded. APIs may change before stability. Node 22+ is supported; browser
+consumers must initialize the WASM module before calling its functions.
+
+```javascript
+import { format_fraction, format_currency } from "tamil-toolkit";
+
+console.log(format_fraction(2, 4)); // 1/2
+console.log(format_currency(102550, "LKR", "SL")); // LKR 1,025.50
+```
+
+The package includes core Unicode/Ezhuthu functions, Agara collation, bounded
+TN/SL integer and currency words, fractions, Gregorian dates, and explicit
+Bamini conversion. For browser code use the `/web` entry point, `await init()`,
+then call the same methods. Hosts must serve the packaged WASM file with the
+generated loader; bundlers must support WebAssembly assets and ES modules.
+See LICENSE, THIRD_PARTY_NOTICES.md, and bundled dependency license notices.
+
+Both entry points expose `compare`, `sort_words`, `sort_key`, and `search_key`.
+Use the comparison result or numeric-array keys for ordering; comparing their
+JSON string representation is incorrect. The versioned `agara-v1` profile and
+its mixed-script fallback are specified at
+https://github.com/abishtakan/tamil-toolkit/tree/HEAD/docs/specs/collate-v0.1.md.