@pylerai/design-system 1.2.1 → 1.2.3

package/README.md

@@ -5,9 +5,9 @@ Pyler Frontend를 위한 디자인 시스템 패키지 (Tailwind CSS + shadcn/ui
 ## 📦 패키지 정보
 
 - **패키지명**: `@pylerai/design-system`
-- **버전**: 1.0.1
+- **버전**: ![npm version](https://img.shields.io/npm/v/@pylerai/design-system)
 - **라이선스**: ISC
-- **레지스트리**: GitHub Packages
+- **레지스트리**: npm (registry.npmjs.org, public)
 - **기술 스택**: React + TypeScript + Tailwind CSS + shadcn/ui + Storybook + Vitest
 
 ## 🚀 설치 및 사용
@@ -16,33 +16,17 @@ Pyler Frontend를 위한 디자인 시스템 패키지 (Tailwind CSS + shadcn/ui
 
 다른 레포지토리에서 이 디자인 시스템을 사용하려면 다음 단계를 따라하세요:
 
-#### 1. GitHub Personal Access Token 생성
+#### 1. 패키지 설치
 
-1. GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
-2. "Generate new token (classic)" 클릭
-3. `read:packages` 권한 체크
-4. 토큰 생성 및 복사 (한 번만 표시되므로 안전하게 보관!)
-
-#### 2. 프로젝트에 `.npmrc` 파일 생성
-
-프로젝트 루트에 `.npmrc` 파일을 생성하고 다음 내용을 추가하세요:
-
-```
-@pylerai:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
-```
-
-`YOUR_GITHUB_TOKEN` 부분을 1단계에서 생성한 토큰으로 교체하세요.
-
-> ⚠️ 주의: `.npmrc` 파일은 절대 git에 커밋하지 마세요! `.gitignore`에 추가되어 있는지 확인하세요.
-
-#### 3. 패키지 설치
+public npm 레지스트리에 배포되어 있으므로 별도 인증 없이 바로 설치할 수 있습니다.
 
 ```bash
 npm install @pylerai/design-system
 ```
 
-#### 4. Tailwind CSS 설정
+> [CHANGELOG](./CHANGELOG.md) · [CONTRIBUTING](./CONTRIBUTING.md)
+
+#### 2. Tailwind CSS 설정
 
 사용할 프로젝트의 `tailwind.config.js` / `tailwind.config.cjs` 파일에 다음을 추가하세요:
 
@@ -75,7 +59,7 @@ import "@pylerai/design-system/style.css";
 
 > 구버전 번들러에서 서브패스가 동작하지 않으면 `@import "@pylerai/design-system/dist/style.css";` 또는 `import "@pylerai/design-system/dist/style.css";` 를 사용하세요.
 
-#### 5. 사용하기
+#### 3. 사용하기
 
 ```typescript
 import { Button } from "@pylerai/design-system";
@@ -170,39 +154,6 @@ module.exports = {
 
 스토리북 **Design Tokens → Color Tokens**에서 전체 스와치와 HEX를 확인할 수 있습니다.
 
-#### 환경별 설정 예시
-
-**`.env` 파일을 사용하는 경우** (추천):
-
-프로젝트 루트에 `.env` 파일 생성:
-
-```
-GITHUB_TOKEN=your_token_here
-```
-
-`.npmrc` 파일:
-
-```
-@pylerai:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
-```
-
-**CI/CD 환경** (GitHub Actions):
-
-워크플로우 파일에 다음 추가:
-
-```yaml
-- uses: actions/checkout@v5
-- uses: actions/setup-node@v4
-  with:
-    node-version: 20
-    registry-url: https://npm.pkg.github.com/
-    scope: "@pylerai"
-- run: npm install @pylerai/design-system
-  env:
-    NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-```
-
 ## 🎨 컴포넌트
 
 ### Typography
@@ -451,59 +402,21 @@ Storybook은 `http://localhost:6006`에서 실행됩니다.
 
 ## 📤 배포
 
-이 프로젝트는 GitHub Actions를 통해 자동 배포됩니다.
+이 프로젝트는 `npm run publish:npm` 실행을 통해 public npm 레지스트리(`registry.npmjs.org`)로 배포됩니다.
 
 ### 배포 프로세스
 
-1. **릴리스 생성**: GitHub에서 새로운 릴리스를 생성하면 자동으로 워크플로우가 트리거됩니다.
-2. **빌드 단계**:
-   - Node.js 20 환경에서 실행
-   - `npm ci`로 의존성 설치
-   - `npm test`로 테스트 실행
-3. **퍼블리시 단계**:
-   - GitHub Packages에 패키지 퍼블리시
-   - 패키지 스코프: `@pylerai`
-   - 레지스트리: `https://npm.pkg.github.com`
-
-### 워크플로우 파일
-
-```yaml:.github/workflows/release-package.yml
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-      - run: npm test
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-    steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://npm.pkg.github.com/
-          scope: "@pylerai"
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+1. **버전 업데이트**: `package.json`의 `version`을 올립니다.
+2. **배포 실행**:
+
+```bash
+npm run publish:npm
 ```
 
+이 스크립트는 `npm run build`로 패키지를 빌드한 뒤, `npm publish --access public`으로 `@pylerai/design-system`을 public 스코프로 퍼블리시합니다.
+
+> ⚠️ `.github/workflows/release-package.yml`은 GitHub Release가 생성될 때 트리거되어 GitHub Packages(`npm.pkg.github.com`)로도 별도 퍼블리시를 시도하는 워크플로우입니다. 현재 실제 배포는 위 수동 `npm run publish:npm` 경로로만 이루어지고 있어 이 워크플로우와 실제 배포 방식이 어긋나 있습니다. GitHub Release를 생성하면 의도치 않게 GitHub Packages 쪽에도 배포가 실행될 수 있으니 주의하세요 (워크플로우 자체 정리는 별도 후속 작업 — [CONTRIBUTING](./CONTRIBUTING.md) 참고).
+
 ## 🔗 링크
 
 - **Repository**: https://github.com/pylerAI/design-system