@han_zzpw/chatbot 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,14 +17,14 @@ A standalone React chatbot component library with streaming support, speech reco
17
17
  ## Installation
18
18
 
19
19
  ```bash
20
- npm install @vdm/chatbot
20
+ npm install @vdmhealth/chatbot
21
21
  ```
22
22
 
23
23
  ## Basic Usage
24
24
 
25
25
  ```jsx
26
26
  import React from 'react';
27
- import { ChatBot } from '@vdm/chatbot';
27
+ import { ChatBot } from '@vdmhealth/chatbot';
28
28
 
29
29
  const MyApp = () => {
30
30
  return (
@@ -141,6 +141,58 @@ index.ts # Main entry point
141
141
  embedApp.tsx # Embedded app entry point
142
142
  ```
143
143
 
144
+
145
+ ### Docker
146
+
147
+ ```bash
148
+ docker build -t chatbot-app .
149
+ docker run -p 3002:3002 chatbot-app
150
+ ```
151
+
152
+ ## Publishing to NPM
153
+
154
+ This library is published as a scoped package: `@vdmhealth/chatbot`.
155
+
156
+ ### First time setup
157
+ 1. Login to your NPM account:
158
+ ```bash
159
+ npm login
160
+ ```
161
+
162
+ ### Publishing the library
163
+ 1. Build the library (generates ESM, UMD, and types in `dist/`):
164
+ ```bash
165
+ npm run build:lib
166
+ ```
167
+ 2. Publish to NPM (using public access since it's a scoped package):
168
+ ```bash
169
+ npm publish --access public
170
+ ```
171
+
172
+ ## Updating the Library
173
+
174
+ When you make changes and want to release a new version:
175
+
176
+ 1. **Update the version** in `package.json` manually or use npm commands:
177
+ ```bash
178
+ # Increment patch version (1.0.2 -> 1.0.3)
179
+ npm version patch
180
+
181
+ # Or for bigger changes:
182
+ # npm version minor
183
+ # npm version major
184
+ ```
185
+
186
+ 2. **Rebuild** the library:
187
+ ```bash
188
+ npm run build:lib
189
+ ```
190
+
191
+ 3. **Publish** again:
192
+ ```bash
193
+ npm publish --access public
194
+ ```
195
+
144
196
  ## Contributing
145
197
 
146
198
  1. Fork the repository