Skip to content

Commit d582431

Browse files
committed
chore: publish under @globus.studio scope
Rename package to @globus.studio/readsight (published to npm under the globus.studio org, public access) and update README install/import references and the npm badge accordingly.
1 parent 85ae083 commit d582431

2 files changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# ReadSight (Node.js) — Multilingual Readability Engine
22

33
[![CI](https://github.com/MADEVAL/ReadSightJS/actions/workflows/ci.yml/badge.svg)](https://github.com/MADEVAL/ReadSightJS/actions/workflows/ci.yml)
4-
[![npm](https://img.shields.io/npm/v/readsight.svg)](https://www.npmjs.com/package/readsight)
4+
[![npm](https://img.shields.io/npm/v/@globus.studio/readsight.svg)](https://www.npmjs.com/package/@globus.studio/readsight)
55
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
66
[![Node](https://img.shields.io/badge/node-%3E%3D18-339933?logo=node.js)](https://nodejs.org/)
77
[![Languages](https://img.shields.io/badge/languages-86-9cf)](#supported-languages)
88
[![Formulas](https://img.shields.io/badge/formulas-17-orange)](#readability-formulas)
99
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](#development)
1010

11-
`readsight` measures text readability across **86 languages**. It implements
11+
`@globus.studio/readsight` measures text readability across **86 languages**. It implements
1212
**17 readability formulas** with language-specific coefficients and uses the
1313
Frank M. Liang (TeX) hyphenation algorithm for syllable counting — all with
1414
**zero runtime dependencies**. It ships as a dual **ESM + CommonJS** package
@@ -38,7 +38,7 @@ There is no "score everything" call — you loop over the formulas the language
3838
supports and call `score()` for each:
3939

4040
```ts
41-
import { ReadSight } from "readsight";
41+
import { ReadSight } from "@globus.studio/readsight";
4242

4343
const rs = new ReadSight("en-us");
4444

@@ -94,7 +94,7 @@ lands on a Thai sentence by mistake.
9494
## Installation
9595

9696
```bash
97-
npm install readsight
97+
npm install @globus.studio/readsight
9898
```
9999

100100
**Requirements:** Node.js >= 18. No other runtime dependencies.
@@ -103,18 +103,18 @@ Works from both ESM and CommonJS:
103103

104104
```ts
105105
// ESM
106-
import { ReadSight } from "readsight";
106+
import { ReadSight } from "@globus.studio/readsight";
107107
```
108108

109109
```js
110110
// CommonJS
111-
const { ReadSight } = require("readsight");
111+
const { ReadSight } = require("@globus.studio/readsight");
112112
```
113113

114114
## Quick Start
115115

116116
```ts
117-
import { ReadSight } from "readsight";
117+
import { ReadSight } from "@globus.studio/readsight";
118118

119119
const engine = new ReadSight("en-us");
120120

@@ -167,7 +167,7 @@ ReadSight has three syllable counting modes, configured per language via
167167
| `"individual"` | Each vowel letter = 1 syllable (Slavic Cyrillic) | `дыхание` → 4 |
168168

169169
```ts
170-
import { ReadSight } from "readsight";
170+
import { ReadSight } from "@globus.studio/readsight";
171171

172172
const ru = new ReadSight("ru"); // heuristic + vowelMode "individual"
173173
ru.syllableCount("дыхание"); // 4
@@ -318,7 +318,7 @@ ReadSight.withConfig(language: string, config: Config): ReadSight
318318
## Custom Configuration
319319

320320
```ts
321-
import { Config, ReadSight } from "readsight";
321+
import { Config, ReadSight } from "@globus.studio/readsight";
322322

323323
// Global default (call once at bootstrap, before creating engines)
324324
ReadSight.setDefaultConfig(new Config("/patterns", "/languages", "/cache"));

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{
2-
"name": "readsight",
2+
"name": "@globus.studio/readsight",
33
"version": "1.0.0",
44
"description": "Multilingual readability library — 86 languages, 17 formulas, TeX-based syllable counting via the Frank M. Liang algorithm. Zero runtime dependencies.",
55
"type": "module",
6+
"publishConfig": {
7+
"access": "public"
8+
},
69
"exports": {
710
".": {
811
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)