Skip to content

docs: drop deprecated downloadModel from README, tabulate languages #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogdcr merged 1 commit into from
Jun 6, 2026
Merged

docs: drop deprecated downloadModel from README, tabulate languages #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,6 @@ Reactive hook: pass a (changing) string and get back the detected entities, reco
| `status` | `ModelStatus` | Current model download state. |
| `error` | `Error \| null` | The last detection or model error, or `null`. |

### `downloadModel()`

> **Deprecated since 0.3.0** — use [`prepareModel()`](#preparemodeloptions) instead. Kept as an alias (always targets the default `'en'` model) and will be removed in a future major version.

### `detect(text, options?)`

Detects entities in the given text using native platform APIs.
Expand Down Expand Up @@ -240,11 +236,15 @@ Detects entities in the given text using native platform APIs.

## Supported Languages

The `language` option selects which **Android** ML Kit model is used. It is a no-op on iOS, where `NSDataDetector` is language-agnostic.

`ModelLanguage`: `'ar'` (Arabic), `'nl'` (Dutch), `'en'` (English), `'fr'` (French), `'de'` (German), `'it'` (Italian), `'ja'` (Japanese), `'ko'` (Korean), `'pl'` (Polish), `'pt'` (Portuguese), `'ru'` (Russian), `'es'` (Spanish), `'th'` (Thai), `'tr'` (Turkish), `'zh'` (Chinese).
The `language` option (type `ModelLanguage`) selects which **Android** ML Kit model is used. It is a no-op on iOS, where `NSDataDetector` is language-agnostic. Each language is a separate ~5.6MB on-device model, downloaded on demand.

Each language is a separate ~5.6MB on-device model, downloaded on demand.
| Code | Language | Code | Language | Code | Language |
| ---- | -------- | ---- | ---------- | ---- | -------- |
| `ar` | Arabic | `it` | Italian | `ru` | Russian |
| `nl` | Dutch | `ja` | Japanese | `es` | Spanish |
| `en` | English | `ko` | Korean | `th` | Thai |
| `fr` | French | `pl` | Polish | `tr` | Turkish |
| `de` | German | `pt` | Portuguese | `zh` | Chinese |

## Platform Differences

Expand Down
Loading