Skip to content

Commit 435973f

Browse files
committed
docs(bun-decompile): clarify Bun runtime requirement
Make it explicit that this package requires Bun and won't work with Node.js due to Bun-specific APIs (Bun.file, Bun.write).
1 parent c2c9c5a commit 435973f

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

packages/bun-decompile/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ bun add @shepherdjerred/bun-decompile
2121
bun add -g @shepherdjerred/bun-decompile
2222
```
2323

24-
Requires [Bun](https://bun.sh) runtime.
24+
> **Note:** This package requires [Bun](https://bun.sh) runtime and will not work with Node.js.
25+
> It uses Bun-specific APIs (`Bun.file()`, `Bun.write()`) for file operations.
2526
2627
## Quick Start
2728

packages/bun-decompile/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@shepherdjerred/bun-decompile",
33
"version": "0.1.0",
4-
"description": "Extract and de-minify source code from Bun-compiled executables using AI",
4+
"description": "Extract and de-minify source code from Bun-compiled executables using AI (Bun runtime required)",
55
"type": "module",
66
"bin": {
77
"bun-decompile": "./src/index.ts"

0 commit comments

Comments
 (0)