@reco-inc/upbox-ui 0.1.1 → 0.1.2

package/README.md

@@ -4,7 +4,11 @@ Upbox Design System - Vue 3 Component Library
 
 ## Storybook
 
-[Live Storybook](https://reco-inc.github.io/upbox-ui/)
+컴포넌트 데모와 props 문서는 Storybook 에서 확인한다.
+
+```bash
+pnpm storybook   # localhost:6006
+```
 
 ## Installation
 
@@ -132,79 +136,15 @@ Figma 팔레트 이름을 그대로 사용:
 
 Add `class="dark"` to the root element. All color tokens automatically invert.
 
-## Development
-
-```bash
-pnpm install        # Install dependencies
-pnpm build          # Build library
-pnpm dev            # Watch mode
-pnpm typecheck      # Type check
-pnpm storybook      # Storybook dev server (localhost:6006)
-pnpm release        # 릴리스 (아래 "배포 & 업데이트" 참고)
-```
-
-## 배포 & 업데이트
-
-npm public 레지스트리(`@reco-inc/upbox-ui`)로 배포한다. 저장소는 private 이고 빌드 산출물만 공개된다.
-
-### 릴리스
-
-```bash
-pnpm release          # patch  0.1.0 -> 0.1.1
-pnpm release minor    # minor  0.1.0 -> 0.2.0
-pnpm release major    # major  0.1.0 -> 1.0.0
-pnpm release 0.4.2    # 특정 버전 지정
-```
-
-한 번 실행하면 아래를 순서대로 처리한다.
-
-1. `pnpm build` 후 `dist/` 가 바뀌었으면 함께 커밋
-2. `package.json` 버전 bump + 커밋 + `v0.1.1` 태그 생성
-3. `git push --follow-tags`
-4. `gh release create` 로 GitHub Release 발행
-5. Release 발행에 반응해 `.github/workflows/publish-npm.yml` 이 npm 에 배포
-
-`main` 이 아니거나, 커밋 안 된 변경이 있거나, `origin/main` 과 어긋나면 중단한다.
-소스만 커밋해 두면 `dist/` 재빌드·커밋은 릴리스 스크립트가 알아서 한다.
-
-### 배포 인증
-
-CI 배포에는 저장소 secret `NPM_TOKEN` 이 필요하다. npmjs 에서 **granular access token**
-을 발급해 등록한다 — `@reco-inc` **스코프** 선택 / Read and write / IP 제한은 비워둔다
-(GitHub Actions 러너 IP 가 고정이 아니다).
-
-```bash
-gh secret set NPM_TOKEN --repo RECO-Inc/upbox-ui
-```
-
-로컬에서 직접 `npm publish` 하는 경우, 계정에 2FA 가 걸려 있으면 OTP 를 넘겨야 한다.
-
-```bash
-npm publish --otp=123456
-```
-
-> `.npmrc` 에 `@reco-inc:registry` 를 두지 않는다. scope registry 설정은
-> `publishConfig.registry` 보다 우선하므로 배포 대상이 조용히 바뀐다.
-
-### Consumer 프로젝트 업데이트
+## 업데이트
 
 ```bash
 pnpm update @reco-inc/upbox-ui
 ```
 
-### Stories 추가/수정 시
-
-- Stories 파일 수정 후 `pnpm build` → dist 의 `.stories.d.ts` 도 함께 커밋
-- `main` 브랜치 push 시 Storybook 이 GitHub Pages 에 자동 배포됨
-
-### 새 컴포넌트 추가 시 체크리스트
+## Contributing
 
-1. `src/components/<name>/` 에 컴포넌트 생성
-2. `src/components/<name>/index.ts` 에서 export
-3. `src/index.ts` 에 `export * from './components/<name>'` 추가
-4. `src/global.ts` 에 GlobalComponents 타입 선언 추가
-5. Stories 파일 작성
-6. `pnpm build` 후 dist 포함하여 커밋
+개발·릴리스·배포 절차는 저장소의 `CONTRIBUTING.md` 를 참고한다.
 
 ## Tech Stack
 

package/package.json

@@ -4,7 +4,7 @@
     "registry": "https://registry.npmjs.org",
     "access": "public"
   },
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "description": "Upbox Design System - Vue 3 Component Library",
   "license": "UNLICENSED",