Skip to content

feat: bare npm name — interscript@3.0.0 #46

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
ronaldtse merged 1 commit into from
Aug 27, 2026
Merged

feat: bare npm name — interscript@3.0.0 #46

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Interscript-TS

[![CI](https://github.com/interscript/interscript-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/interscript/interscript-ts/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/interscript-ts)](https://www.npmjs.com/package/interscript-ts)
[![npm](https://img.shields.io/npm/v/interscript)](https://www.npmjs.com/package/interscript)

TypeScript runtime for [Interscript](https://www.interscript.org) — interoperable script conversion systems.

Expand All @@ -14,13 +14,13 @@ A TypeScript-native port of the [Ruby runtime](https://github.com/interscript/in
## Installation

```bash
npm install interscript-ts
npm install interscript
```

## Quick start

```typescript
import { transliterate, configure, bundledStrategy } from "interscript-ts"
import { transliterate, configure, bundledStrategy } from "interscript"

// Load IR maps from a JSON dictionary (e.g. fetched, bundled, or read from disk)
configure({
Expand All @@ -38,7 +38,7 @@ transliterate("alalc-amh-Ethi-Latn-2011", "ኢትዮጵያ") // → "ʼiteyop
## Filesystem loader (Node)

```typescript
import { configure, transliterate, filesystemStrategy } from "interscript-ts"
import { configure, transliterate, filesystemStrategy } from "interscript"

configure({ strategies: [filesystemStrategy("./maps")] })
// reads `./maps/<systemCode>.json` on demand, caches
Expand All @@ -47,7 +47,7 @@ configure({ strategies: [filesystemStrategy("./maps")] })
## CLI

```bash
npx interscript-ts -s bgnpcgn-ukr-Cyrl-Latn-2019 -i input.txt --maps-dir ./maps
npx interscript -s bgnpcgn-ukr-Cyrl-Latn-2019 -i input.txt --maps-dir ./maps
```

Reads stdin if `-i` is omitted; writes stdout if `-o` is omitted.
Expand Down
10 changes: 6 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "interscript-ts",
"version": "0.1.0",
"name": "interscript",
"version": "3.0.0",
"description": "Interscript TypeScript runtime — interoperable script conversion",
"type": "module",
"main": "./dist/index.js",
Expand All @@ -23,9 +23,11 @@
"./package.json": "./package.json"
},
"bin": {
"interscript-ts": "./dist/cli.js"
"interscript": "./dist/cli.js"
},
"sideEffects": ["dist/ml/models/**/*.js"],
"sideEffects": [
"dist/ml/models/**/*.js"
],
"engines": {
"node": ">=20"
},
Expand Down
Loading