Skip to content

Commit b18acff

Browse files
heznpcheznpc
andauthored
docs: add create-starter install path to Quick Start (#13)
Recommend npx @starter-series/create as the first install option, with direct git clone as the fallback. Preserves the package.json deploy-project-name warning, clarifying create-starter handles name automatically while repository.url still needs manual update. Co-authored-by: heznpc <wantcongz@gmail.com>
1 parent 35c71a6 commit b18acff

2 files changed

Lines changed: 20 additions & 30 deletions

File tree

README.ko.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,22 @@
2424

2525
## 빠른 시작
2626

27-
> ⚠️ **가장 먼저 할 일: `package.json``name`을 바꾸세요** (`"my-site"` → 실제 프로젝트 이름), 그리고 `repository.url``YOUR_USERNAME/YOUR_SITE`도 교체하세요. `deploy` 스크립트가 `$npm_package_name`을 Cloudflare Pages 프로젝트 이름으로 사용합니다 — **건너뛰면 CD가 엉뚱한 프로젝트에 배포하거나 실패합니다.**
27+
**[create-starter](https://github.com/starter-series/create-starter) 사용** (추천):
2828

2929
```bash
30-
# 1. GitHub에서 "Use this template" 클릭 (또는 clone)
31-
git clone https://github.com/starter-series/cloudflare-pages-starter.git my-site
32-
cd my-site
33-
34-
# 2. ⚠️ 필수 — package.json 수정
35-
# → "name"을 "my-site"에서 Cloudflare Pages 프로젝트 이름으로 변경
36-
# → repository.url의 YOUR_USERNAME/YOUR_SITE 교체
37-
# → description 업데이트
38-
39-
# 3. 의존성 설치
40-
npm install
30+
npx @starter-series/create my-site --template cloudflare-pages
31+
cd my-site && npm install && npm run dev
32+
```
4133

42-
# 4. 로컬 개발 서버 시작
43-
npm run dev
34+
**또는 직접 clone:**
4435

45-
# 5. src/를 직접 작성한 사이트 파일로 교체
36+
```bash
37+
git clone https://github.com/starter-series/cloudflare-pages-starter my-site
38+
cd my-site && npm install && npm run dev
4639
```
4740

41+
> ⚠️ **배포 전 필수: `package.json``name`을 바꾸세요** (`"my-site"` → 실제 Cloudflare Pages 프로젝트 이름), 그리고 `repository.url``YOUR_USERNAME/YOUR_SITE`도 교체하세요. `deploy` 스크립트가 `$npm_package_name`을 Cloudflare Pages 프로젝트 이름으로 사용합니다 — **건너뛰면 CD가 엉뚱한 프로젝트에 배포하거나 실패합니다.** (create-starter는 `name`을 자동으로 설정합니다. `repository.url`은 수동 설정이 필요합니다.)
42+
4843
## 포함된 구성
4944

5045
```

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,22 @@ Build your site. Push to deploy. Free and fast.
2424

2525
## Quick Start
2626

27-
> ⚠️ **Do this FIRST: rename `package.json` `name`** (from `"my-site"`) and update `repository.url` (replace `YOUR_USERNAME/YOUR_SITE`). The `deploy` script uses `$npm_package_name` as the Cloudflare Pages project name — **CD will silently deploy to the wrong project (or fail) if you skip this.**
27+
**Via [create-starter](https://github.com/starter-series/create-starter)** (recommended):
2828

2929
```bash
30-
# 1. Click "Use this template" on GitHub (or clone)
31-
git clone https://github.com/starter-series/cloudflare-pages-starter.git my-site
32-
cd my-site
33-
34-
# 2. ⚠️ REQUIRED — Update package.json
35-
# → Change "name" from "my-site" to your Cloudflare Pages project name
36-
# → Replace YOUR_USERNAME/YOUR_SITE in repository.url
37-
# → Update description
38-
39-
# 3. Install dependencies
40-
npm install
30+
npx @starter-series/create my-site --template cloudflare-pages
31+
cd my-site && npm install && npm run dev
32+
```
4133

42-
# 4. Start local dev server
43-
npm run dev
34+
**Or clone directly:**
4435

45-
# 5. Replace src/ with your site files
36+
```bash
37+
git clone https://github.com/starter-series/cloudflare-pages-starter my-site
38+
cd my-site && npm install && npm run dev
4639
```
4740

41+
> ⚠️ **Before deploying: rename `package.json` `name`** (from `"my-site"` to your Cloudflare Pages project name) and update `repository.url` (replace `YOUR_USERNAME/YOUR_SITE`). The `deploy` script uses `$npm_package_name` as the Cloudflare Pages project name — **CD will silently deploy to the wrong project (or fail) if you skip this.** (create-starter handles the `name` automatically; you still need to set `repository.url`.)
42+
4843
## What's Included
4944

5045
```

0 commit comments

Comments
 (0)