From 7aafae9a68c30511237257797d3b81250be4d5d3 Mon Sep 17 00:00:00 2001 From: Ronald Tse Date: Thu, 20 Aug 2026 15:48:53 +0800 Subject: [PATCH] README: document the optional phonological layer (secryst crystals + interscript-ml index) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index cddf8812..d665e77e 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,17 @@ image:https://github.com/interscript/interscript-ruby/actions/workflows/rake.yml # Interscript Documentation is available directory higher in file README.adoc. + +## Phonological layer (optional) + +Some transliteration systems need their input vocalized before the map +can apply (undiacritized Arabic, nikud-less Hebrew, unsegmented Thai). +The stdlib ships adapters for this: the `secryst` function dispatches +to a [secryst crystal](https://www.secryst.org) — +`gem 'secryst'` (Ruby), `pip install secryst`, or `npm i secryst` — +which resolves a model id through the +[interscript-ml `models.yaml` index](https://github.com/interscript/interscript-ml) +and runs sha256-verified ONNX inference locally. The gem has no +interscript dependency: a crystal can be used standalone for any G2P +need, and an engine without a crystal simply cannot execute maps that +declare a vocalization step.