Skip to content

Commit 417c877

Browse files
committed
Clarify README quickstart
1 parent 227ccbc commit 417c877

3 files changed

Lines changed: 23 additions & 17 deletions

File tree

README.ko.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
웹사이트, localhost 앱, SaaS 대시보드를 실제 데스크톱 앱 프로젝트로 바꿉니다.
1212

1313
```bash
14-
npx appbun@latest https://github.com --name "GitHub" --dmg
14+
npx -y appbun@latest https://github.com --name "GitHub" --dmg
1515
```
1616

1717
`appbun`은 정체를 알 수 없는 바이너리 하나를 던져주지 않습니다. 읽고 고칠 수 있는 [Electrobun](https://electrobun.dev) 프로젝트, 아이콘, native-runner 빌드 스크립트, macOS DMG 패키징, 에이전트용 지침까지 함께 만들어줍니다.
@@ -24,9 +24,10 @@ npx appbun@latest https://github.com --name "GitHub" --dmg
2424
| --- | --- | --- |
2525
| 공개 사이트 앱으로 만들기 | `appbun https://example.com --name Example` | 수정 가능한 데스크톱 wrapper 프로젝트 |
2626
| 로컬 프론트엔드 앱으로 만들기 | `appbun dev --name "My App"` | 흔한 localhost 포트 자동 감지 |
27-
| 개인용 macOS installer 만들기 | `appbun package --dmg` | 비서명 로컬 DMG |
28-
| signed 배포 준비 | `appbun package --dmg --sign` | `APPLE_SIGN_IDENTITY` 필요 |
29-
| notarized 배포 준비 | `appbun package --notarize` | Apple notary 환경변수 사용 |
27+
| 생성과 패키징 한 번에 하기 | `appbun https://example.com --name Example --dmg` | 프로젝트와 비서명 macOS DMG |
28+
| 개인용 macOS installer 만들기 | `appbun package --dmg` | 생성 프로젝트 안에서 비서명 로컬 DMG 생성 |
29+
| 서명 배포 준비 | `appbun package --dmg --sign` | `APPLE_SIGN_IDENTITY` 필요 |
30+
| 노터라이즈 배포 준비 | `appbun package --notarize` | Apple notary 환경변수 사용 |
3031
| 에이전트에게 맡기기 | `appbun skill --install-claude --cwd .` | Claude Code용 가이드 설치 |
3132

3233
## 60초 경로
@@ -36,20 +37,22 @@ npx appbun@latest https://github.com --name "GitHub" --dmg
3637
```bash
3738
cd your-web-app
3839
npm run dev
39-
npx appbun@latest dev --name "My App" --out-dir ../appbun-output/my-app --yes
40+
npx -y appbun@latest dev --name "My App" --out-dir ../appbun-output/my-app --yes
4041
cd ../appbun-output/my-app
41-
npx appbun@latest doctor --project
42-
npx appbun@latest package --install
42+
npx -y appbun@latest doctor --project
43+
npx -y appbun@latest package --install
4344
```
4445

4546
macOS에서 DMG 만들기:
4647

4748
```bash
48-
npx appbun@latest package --dmg
49+
npx -y appbun@latest package --dmg
4950
```
5051

5152
생성된 프로젝트는 평범한 코드입니다. 열어보고, shell을 고치고, 커밋하고, CI에 올리고, 다른 개발자에게 넘길 수 있습니다.
5253

54+
이 경로는 `appbun@latest` 기준으로 스모크 테스트합니다: 공개 URL scaffold, `appbun.generated.json` 확인, 의존성 설치, Electrobun 앱 빌드, 비서명 macOS DMG 생성.
55+
5356
## 왜 다른가
5457

5558
많은 URL-to-app 도구는 가장 짧은 데모에 집중합니다. `appbun`은 다음 날에도 계속 다룰 수 있는 결과물에 집중합니다.
@@ -74,7 +77,7 @@ npm install -g appbun
7477
설치 없이 바로 실행:
7578

7679
```bash
77-
npx appbun@latest chatgpt --dmg
80+
npx -y appbun@latest chatgpt --dmg
7881
```
7982

8083
`appbun`은 Bun이 있으면 Bun을 우선 사용합니다. Bun이 없으면 `--package-manager`로 강제하지 않는 한 npm으로 폴백할 수 있습니다.

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
Turn a website, localhost app, or SaaS dashboard into a real desktop app project.
1212

1313
```bash
14-
npx appbun@latest https://github.com --name "GitHub" --dmg
14+
npx -y appbun@latest https://github.com --name "GitHub" --dmg
1515
```
1616

1717
`appbun` does not give you a mystery binary. It generates an inspectable [Electrobun](https://electrobun.dev) project with source code, icons, native-runner build scripts, macOS DMG packaging, and agent-friendly instructions.
@@ -24,7 +24,8 @@ npx appbun@latest https://github.com --name "GitHub" --dmg
2424
| --- | --- | --- |
2525
| Package a public site | `appbun https://example.com --name Example` | Editable desktop wrapper project |
2626
| Package your local frontend | `appbun dev --name "My App"` | Auto-detects common localhost ports |
27-
| Make a personal macOS installer | `appbun package --dmg` | Unsigned local DMG |
27+
| Generate and package in one go | `appbun https://example.com --name Example --dmg` | Project plus unsigned macOS DMG |
28+
| Make a personal macOS installer | `appbun package --dmg` | Unsigned local DMG from inside a generated project |
2829
| Prepare signed distribution | `appbun package --dmg --sign` | Requires `APPLE_SIGN_IDENTITY` |
2930
| Prepare notarized distribution | `appbun package --notarize` | Uses Apple notary env vars |
3031
| Let an agent do it | `appbun skill --install-claude --cwd .` | Claude Code guide in your repo |
@@ -36,20 +37,22 @@ Package a running local app:
3637
```bash
3738
cd your-web-app
3839
npm run dev
39-
npx appbun@latest dev --name "My App" --out-dir ../appbun-output/my-app --yes
40+
npx -y appbun@latest dev --name "My App" --out-dir ../appbun-output/my-app --yes
4041
cd ../appbun-output/my-app
41-
npx appbun@latest doctor --project
42-
npx appbun@latest package --install
42+
npx -y appbun@latest doctor --project
43+
npx -y appbun@latest package --install
4344
```
4445

4546
On macOS, make a DMG:
4647

4748
```bash
48-
npx appbun@latest package --dmg
49+
npx -y appbun@latest package --dmg
4950
```
5051

5152
The generated project remains normal code. Open it, edit the shell, commit it, run it in CI, or hand it to another developer.
5253

54+
This path is smoke-tested against `appbun@latest`: scaffold a public URL, inspect `appbun.generated.json`, install dependencies, build the Electrobun app, and create an unsigned macOS DMG.
55+
5356
## Why It Feels Different
5457

5558
Most URL-to-app tools optimize for the shortest demo. `appbun` optimizes for the next day too.
@@ -74,7 +77,7 @@ npm install -g appbun
7477
Or skip installation:
7578

7679
```bash
77-
npx appbun@latest chatgpt --dmg
80+
npx -y appbun@latest chatgpt --dmg
7881
```
7982

8083
`appbun` prefers Bun when it is available. If Bun is missing, it can fall back to npm unless you force `--package-manager`.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "appbun",
3-
"version": "0.10.3",
3+
"version": "0.10.4",
44
"description": "Turn any webpage into a desktop app with one command using Electrobun.",
55
"license": "MIT",
66
"type": "module",

0 commit comments

Comments
 (0)