Skip to content

Commit 024d6fd

Browse files
committed
chore: update readme
1 parent 091a508 commit 024d6fd

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ function App() {
5050
search-url="your-edge-function-url"
5151
api-key="your-api-key"
5252
title="Your Docs"
53-
empty-state-title="How can we help?"
54-
empty-state-description="Ask us anything about the documentation">
53+
>
5554
</docs-chatbot>
5655
</body>
5756
</html>
@@ -62,16 +61,12 @@ function App() {
6261
```html
6362
<script src="https://unpkg.com/@sqliteai/docs-chatbot/dist/umd/docs-chatbot.min.js"></script>
6463

65-
<docs-chatbot
66-
title="Your Docs"
67-
empty-state-title="How can we help?"
68-
empty-state-description="Ask us anything about the documentation">
69-
</docs-chatbot>
64+
<docs-chatbot title="Your Docs"> </docs-chatbot>
7065

7166
<script>
72-
const chatbot = document.querySelector('docs-chatbot');
73-
chatbot.setAttribute('search-url', 'your-edge-function-url');
74-
chatbot.setAttribute('api-key', 'your-api-key');
67+
const chatbot = document.querySelector("docs-chatbot");
68+
chatbot.setAttribute("search-url", "your-edge-function-url");
69+
chatbot.setAttribute("api-key", "your-api-key");
7570
</script>
7671
```
7772

@@ -82,7 +77,8 @@ function App() {
8277
search-url="your-edge-function-url"
8378
api-key="your-api-key"
8479
title="Your Docs"
85-
style="--primary: #f5426c; --primary-foreground: #ffffff">
80+
style="--primary: #f5426c; --primary-foreground: #ffffff"
81+
>
8682
</docs-chatbot>
8783
```
8884

@@ -101,10 +97,10 @@ function App() {
10197

10298
### Web Component Attributes
10399

104-
| Attribute | Required | Description |
105-
| ----------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
106-
| `search-url` | Yes | Full URL of your deployed SQLite Cloud edge function (e.g., `https://yourproject.sqlite.cloud/v2/functions/aisearch-docs`) |
107-
| `api-key` | Yes | SQLite Cloud API key with permissions to execute the edge function |
108-
| `title` | Yes | Title displayed in the chatbot header |
109-
| `empty-state-title` | No | Main heading shown before the first message |
110-
| `empty-state-description` | No | Subtext shown below the empty state title |
100+
| Attribute | Required | Description |
101+
| ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
102+
| `search-url` | Yes | Full URL of your deployed SQLite Cloud edge function (e.g., `https://yourproject.sqlite.cloud/v2/functions/aisearch-docs`) |
103+
| `api-key` | Yes | SQLite Cloud API key with permissions to execute the edge function |
104+
| `title` | Yes | Title displayed in the chatbot header |
105+
| `empty-state-title` | No | Main heading shown before the first message |
106+
| `empty-state-description` | No | Subtext shown below the empty state title |

0 commit comments

Comments
 (0)