Skip to content

Commit e520985

Browse files
docs: add JSR installation instructions to README
- Add recommended JSR installation method - Show both global CLI install and project dependency usage - Update module usage example with JSR import - Keep source installation as alternative method 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
1 parent cd22fe6 commit e520985

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,26 @@ This transpiler enables WoW emulation developers to:
3333
### Installation & Usage
3434

3535
> **Note**: This package uses the TypeScript Compiler API (npm:typescript) for parsing and type checking.
36-
> It is now fully compatible with JSR.io publishing and can be used in any Deno project.
36+
> It is now published on JSR.io and can be easily installed in any Deno project.
37+
38+
#### Install from JSR (Recommended)
39+
40+
```bash
41+
# Install globally as a CLI tool
42+
deno install -Arf -n tsc2cxx jsr:@wowemulation-dev/typescript2cxx/cli
43+
44+
# Use the installed CLI
45+
tsc2cxx input.ts -o output/
46+
47+
# Or add to your project
48+
deno add @wowemulation-dev/typescript2cxx
49+
```
50+
51+
#### Install from Source
3752

3853
```bash
3954
# Clone the repository
40-
git clone https://github.com/danielsreichenbach/typescript2cxx
55+
git clone https://github.com/wowemulation-dev/typescript2cxx
4156
cd typescript2cxx
4257

4358
# Run directly with Deno
@@ -51,7 +66,11 @@ deno compile --allow-net --allow-read --allow-write --output typescript2cxx src/
5166
### Module Usage
5267

5368
```typescript
54-
import { transpile } from "./src/mod.ts";
69+
// Import from JSR
70+
import { transpile } from "@wowemulation-dev/typescript2cxx";
71+
72+
// Or import from local source
73+
// import { transpile } from "./src/mod.ts";
5574

5675
// Transpile TypeScript to C++
5776
const result = await transpile(`

0 commit comments

Comments
 (0)