typing.works 0.0.1 → 0.3.0-beta.3

package/README.md

@@ -1,5 +1,64 @@
-# typing.works
+# typing.works — terminal (beta)
 
-typing.works 터미널판은 준비 중입니다. · Coming soon.
+터미널에서 치는 [typing.works](https://typing.works). 한글·영문 타자 연습, 웹과 같은 판정, 로그인하면 기록·통계·랭크전까지.
+Typing practice from [typing.works](https://typing.works), in your terminal — Korean & English, same scoring as the web, records, stats and ranked matches.
 
-https://typing.works
+## 설치 · Install
+
+```sh
+npx typing.works                              # 설치 없이 바로 · run without installing
+npm i -g typing.works                         # 늘 쓰려면 · install → `typingworks`
+brew install pers-dev/tap/typing.works       # macOS · Linux
+```
+
+macOS (Apple Silicon · Intel) · Linux (x64 · arm64 · 32-bit x86). 통신(로그인·기록)에 `curl`, 기록 올리기에 `gzip` 을 씁니다.
+Windows는 아직입니다 — WSL에서 돌아갑니다.
+
+## 쓰는 법 · Keys
+
+켜면 바로 단문을 칩니다. · It opens straight into typing.
+
+| 키 | |
+|---|---|
+| Enter · Space | 문장 끝 · finish |
+| Esc | 처음부터 · restart |
+| ↑ ↓ | 다음·이전 문장 · next/prev |
+| Tab | 한/영 — 입력기는 영문으로 두고 두벌식 자리 그대로 · Korean/English (keep your OS input in English) |
+| ^S ^L ^P | 단문 · 장문 · 팬그램 · sentence · paragraph · pangram |
+| ^E | 문장 언어 · language |
+| ^Z | 문장 크게/보통(macOS 터미널 · xterm) · bigger text |
+| ^R | 기록 · 통계 · records & stats |
+| ^K | 랭크전 · ranked |
+| ^O ^A ^G ^Q | 설정 · 계정 · 도움말 · 끝 · settings · account · help · quit |
+
+계정은 typing.works 와 같습니다. 한글은 한글이 든 고정폭 글꼴(D2Coding · Sarasa Mono K 등)에서 가장 보기 좋습니다.
+
+## 익명 사용 통계 · Anonymous usage stats
+
+어떻게 쓰이는지 알려고 아주 적은 것만 보냅니다. · We send a small amount of anonymous data to learn how it's used.
+
+- **보내는 것 · sent**: 켰다 · 묶음을 끝냈다(언어 · 갈래 · 문장 수 · 평균 타/분 · 정확도) · 랭크 판 결과 · 로그인했다 — 판 번호 · OS · 터미널 이름과 함께. 사람이 아니라 이 기기에서 만든 난수 ID로 셉니다.
+- **보내지 않는 것 · never sent**: 친 글 · 문장 · 계정(이메일 · 닉네임).
+- **끄기 · opt out**: 설정(^O) «익명 사용 통계» · `TW_NO_TELEMETRY=1` · `DO_NOT_TRACK=1` · `typingworks --no-telemetry`
+- **무엇이 나가는지 보기 · see exactly what is sent**: `TW_TELEMETRY_LOG=~/tw-telemetry.log typingworks`
+
+## 새 판 · Updates
+
+켤 때(6시간에 한 번) npm 에 새 판이 있는지 보고, 있으면 오른쪽 위에 알립니다. **^U** 를 누르면 깐 방법대로 올리고 새 판으로 다시 켭니다.
+Checks npm for a newer version (every 6 hours) and shows it top-right. Press **^U** to update the way you installed it and restart.
+
+| 깐 방법 · installed with | ^U 가 돌리는 것 · runs |
+|---|---|
+| brew | `brew upgrade typing.works` |
+| npm i -g | `npm i -g typing.works@latest` |
+| npx | `npx typing.works@latest` |
+
+끄기 · disable: `TW_NO_UPDATE_CHECK=1`
+
+## 저장 · Data
+
+`~/.typingworks` — 설정 · 이 기기의 기록 · 로그인 토큰(이 파일에만, 권한 600). 지우면 처음 상태가 됩니다.
+
+## License
+
+© 2026 Perspective. All rights reserved. 무료로 쓸 수 있습니다. 자세한 것은 LICENSE.

package/bin/typing.works.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+// typing.works — 이 기기에 맞는 실행 파일을 골라 그대로 넘긴다(입출력 · 종료 코드 · 신호 그대로). 설치 스크립트는 없다.
+"use strict";
+const { spawnSync } = require("child_process");
+const path = require("path");
+const fs = require("fs");
+const key = `${process.platform}-${process.arch}`;
+const exe = path.join(__dirname, "..", "vendor", key, "typingworks");
+if (!fs.existsSync(exe)) {
+  console.error(`typing.works: ${key} 은 아직 지원하지 않습니다 — macOS · Linux(x64 · arm64 · x86). Windows 는 WSL 에서 돌아갑니다.`);
+  console.error(`typing.works: ${key} is not supported yet — macOS and Linux only (use WSL on Windows).`);
+  process.exit(1);
+}
+try { fs.accessSync(exe, fs.constants.X_OK); } catch { try { fs.chmodSync(exe, 0o755); } catch {} }
+const r = spawnSync(exe, process.argv.slice(2), { stdio: "inherit" });
+if (r.error) { console.error(`typing.works: ${r.error.message}`); process.exit(1); }
+if (r.signal) process.kill(process.pid, r.signal);
+process.exit(r.status === null ? 1 : r.status);

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "typing.works",
-  "version": "0.0.1",
-  "description": "typing.works — terminal (준비 중 · coming soon)",
-  "homepage": "https://typing.works",
+  "version": "0.3.0-beta.3",
+  "description": "typing.works in your terminal — Korean & English typing practice, records, stats and ranked matches",
+  "bin": {
+    "typing.works": "bin/typing.works.js",
+    "typingworks": "bin/typing.works.js"
+  },
+  "files": ["bin", "vendor", "README.md", "LICENSE"],
+  "os": ["darwin", "linux"],
+  "cpu": ["arm64", "x64", "ia32"],
+  "engines": { "node": ">=14" },
   "license": "SEE LICENSE IN LICENSE",
-  "bin": { "typing.works": "bin/hold.js", "typingworks": "bin/hold.js" },
-  "files": ["bin/", "README.md", "LICENSE"]
+  "homepage": "https://typing.works",
+  "author": "typing.works",
+  "keywords": ["typing", "typing-practice", "typing-test", "korean", "hangul", "terminal", "tui", "cli", "wpm"]
 }

package/bin/hold.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-console.log("typing.works 터미널판은 준비 중입니다 — https://typing.works");
-console.log("The typing.works terminal edition is coming soon — https://typing.works");