oasis-chat 0.2.5 → 0.2.6

package/README.md

@@ -1,6 +1,21 @@
-# Oasis Button
+# Oasis Chat
 
-`createButton`을 제공하는 가벼운 바닐라 JS 버튼 컴포넌트입니다. React와 Vue를 위한 wrapper 컴포넌트도 제공됩니다.
+`createButton`을 제공하는 가벼운 바닐라 JS 채팅 버튼 컴포넌트입니다. React와 Vue를 위한 wrapper 컴포넌트도 제공됩니다.
+
+## 프로젝트 구조
+
+```
+src/
+├── wrapper/          # 프레임워크별 래퍼 컴포넌트
+│   ├── react/       # React wrapper
+│   └── vue/         # Vue wrapper
+└── app/              # 메인 애플리케이션 로직
+    ├── assets/      # 이미지 등 리소스
+    ├── service/     # API 클라이언트 (auth, http, portal)
+    ├── utils/       # 유틸리티 함수
+    ├── index.js     # 메인 export (createButton)
+    └── style.css    # 스타일시트
+```
 
 ## 설치
 
@@ -82,7 +97,13 @@ React 프로젝트에서 사용할 때는 wrapper 컴포넌트를 사용하면 C
 import { OasisButton } from 'oasis-chat/react';
 
 function App() {
-  return <OasisButton label="Hello 버튼" onClick={() => alert('hello')} />;
+  return (
+    <OasisButton
+      account_id="your-account-id"
+      password="your-password"
+      assistant_uuid="your-assistant-uuid"
+    />
+  );
 }
 ```
 
@@ -93,14 +114,14 @@ Vue 프로젝트에서 사용할 때도 wrapper 컴포넌트를 사용하면 CSS
 ```vue
 <script setup>
 import { OasisButton } from 'oasis-chat/vue';
-
-const handleClick = () => {
-  alert('hello');
-};
 </script>
 
 <template>
-  <OasisButton label="Hello 버튼" :on-click="handleClick" />
+  <OasisButton
+    account_id="your-account-id"
+    password="your-password"
+    assistant_uuid="your-assistant-uuid"
+  />
 </template>
 ```
 
@@ -113,8 +134,9 @@ import { createButton } from 'oasis-chat';
 import 'oasis-chat/style.css'; // CSS 파일 import 필요
 
 const btn = createButton({
-  label: 'Hello 버튼',
-  onClick: () => alert('hello'),
+  account_id: 'your-account-id',
+  password: 'your-password',
+  assistant_uuid: 'your-assistant-uuid',
 });
 
 document.body.appendChild(btn);
@@ -122,13 +144,25 @@ document.body.appendChild(btn);
 
 **참고**: React나 Vue wrapper를 사용할 때는 CSS를 별도로 import할 필요가 없습니다. wrapper 컴포넌트 내부에서 자동으로 CSS가 포함됩니다.
 
+## Props
+
+- `account_id` (string, 필수): 로그인에 사용할 계정 ID
+- `password` (string, 필수): 로그인에 사용할 비밀번호
+- `assistant_uuid` (string, 필수): 어시스턴트 UUID
+
 ## 개발/빌드
 
 ```bash
 npm run dev           # 데모 앱 실행 (Vite)
-npm run build:lib     # 라이브러리 빌드 (dist 생성)
+npm run build:lib     # 라이브러리 빌드 (Vanilla JS, React, Vue 모두 빌드)
 ```
 
+빌드 후 `dist/` 폴더에 다음 파일들이 생성됩니다:
+- `index.*.js` - Vanilla JS 버전
+- `react/index.*.js` - React wrapper 버전
+- `vue/index.*.js` - Vue wrapper 버전
+- `oasis-chat.css` - 스타일시트
+
 ## 라이선스
 
 MIT