Skip to content

Commit 6154af1

Browse files
committed
docs: clarify CDN usage
1 parent f42451c commit 6154af1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ function MyApp() {
153153
154154
### Standalone Javascript
155155
156+
**Recommended approach** - use the self-contained standalone bundle:
157+
156158
```html
157159
<script src="https://unpkg.com/@snf/[email protected]/dist/access-qa-bot.standalone.js"></script>
158160

@@ -168,6 +170,8 @@ qaBot({
168170
</script>
169171
```
170172
173+
> **Note**: Early versions (v0.1.x) supported a "three files" CDN approach using `/build/` directory files. This approach is no longer supported as the build architecture changed from auto-executing scripts to library exports. Use the standalone bundle above instead.
174+
171175
#### Programmatic Control
172176
173177
When using the JavaScript API in plain HTML/JS (requires standalone bundle), you get a controller object with imperative methods:
@@ -264,6 +268,7 @@ The package includes both `/dist/` and `/build/` directories:
264268
- `access-qa-bot.standalone.js` (Self-contained for plain HTML)
265269
266270
- **`/build/`**: React app build files
271+
- **Not for standalone CDN usage** (use `/dist/access-qa-bot.standalone.js` instead)
267272
- Required for shadow DOM implementations that need to import CSS directly
268273
- Example: `import qaStyle from '@snf/access-qa-bot/build/static/css/main.css?inline'`
269274
- Maintained for backward compatibility with existing integrations

0 commit comments

Comments
 (0)