indickit 0.4.0 → 0.4.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.
Files changed (2) hide show
  1. package/README.md +13 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -26,26 +26,31 @@ measured on data that its rules were never built on.
26
26
 
27
27
  ## Install
28
28
 
29
- Go:
29
+ Go 1.22 or later:
30
30
 
31
31
  ```sh
32
32
  go get github.com/micahchoo/indickit
33
33
  ```
34
34
 
35
- JavaScript or TypeScript, from GitHub (no npm account needed):
35
+ JavaScript or TypeScript, on Node 20 or later, Bun or Deno:
36
36
 
37
37
  ```sh
38
- npm install github:micahchoo/indickit#v0.4.0
39
- bun add github:micahchoo/indickit#v0.4.0
38
+ npm install indickit
39
+ bun add indickit
40
+ deno add npm:indickit
40
41
  ```
41
42
 
43
+ The package is ES modules only; `require()` works from Node 20.19. In
44
+ TypeScript, set `moduleResolution` to `nodenext` or `bundler`; the old
45
+ `node10` cannot find the four utilities.
46
+
42
47
  In a browser, with no build step:
43
48
 
44
49
  ```js
45
- import { normalize } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.0/dist/normalize.js";
46
- import { stem } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.0/dist/stem.js";
47
- import { match } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.0/dist/phonetic.js";
48
- import { segment } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.0/dist/segment.js";
50
+ import { normalize } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.3/dist/normalize.js";
51
+ import { stem } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.3/dist/stem.js";
52
+ import { match } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.3/dist/phonetic.js";
53
+ import { segment } from "https://cdn.jsdelivr.net/gh/micahchoo/indickit@v0.4.3/dist/segment.js";
49
54
  ```
50
55
 
51
56
  Each utility is its own file, so a page loads only the rules it uses.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "indickit",
3
- "version": "0.4.0",
3
+ "version": "0.4.3",
4
4
  "description": "Small, exact utilities for text in Indian languages: a phonetic key that matches a name across 21 Indian scripts and English, a normalizer that gives text that looks the same one encoding, a segmenter for the letters a reader sees, and a stemmer for search.",
5
5
  "license": "MIT",
6
6
  "packageManager": "bun@1.3.14",