Skip to content

Commit 0628949

Browse files
committed
chore: update readme
1 parent 90a91ba commit 0628949

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @sqliteai/docs-chatbot
22

3+
[![Status](https://img.shields.io/badge/status-in%20development-yellow)](https://github.com/sqliteai/docs-chatbot)
4+
35
Documentation search chatbot powered by SQLite and AI.
46

57
## Prerequisites
@@ -9,16 +11,14 @@ Before using this chatbot, you need to:
911
1. **Index your documentation** - Use the [SQLite AI Search Action](https://github.com/sqliteai/sqlite-aisearch-action) to create embeddings from your documentation files
1012
2. **Create an edge function** - Follow the [setup guide](https://github.com/sqliteai/sqlite-aisearch-action#create-the-search-edge-function) to deploy the search edge function
1113

12-
## Installation
14+
## Usage
15+
16+
### React Application
1317

1418
```bash
1519
npm install @sqliteai/docs-chatbot
1620
```
1721

18-
## Usage
19-
20-
### React Application
21-
2222
```tsx
2323
import { DocsChatbot } from "@sqliteai/docs-chatbot";
2424
import "@sqliteai/docs-chatbot/style.css";
@@ -62,11 +62,11 @@ function App() {
6262

6363
## Props / Configuration
6464

65-
| Property | Type | Required | Description |
66-
| ------------------------ | -------- | -------- | -------------------------------------------- |
65+
| Property | Type | Required | Description |
66+
| ------------------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
6767
| `searchUrl` | `string` | Yes | Full URL of your deployed SQLite Cloud edge function (e.g., `https://yourproject.sqlite.cloud/v2/functions/aisearch-docs`) |
68-
| `apiKey` | `string` | Yes | SQLite Cloud API key with permissions to execute the edge function |
69-
| `title` | `string` | Yes | Title displayed in the chatbot header |
70-
| `emptyState` | `object` | No | Customizes the initial empty state of the chatbot |
71-
| `emptyState.title` | `string` | No | Main heading shown before the first message |
72-
| `emptyState.description` | `string` | No | Subtext shown below the empty state title |
68+
| `apiKey` | `string` | Yes | SQLite Cloud API key with permissions to execute the edge function |
69+
| `title` | `string` | Yes | Title displayed in the chatbot header |
70+
| `emptyState` | `object` | No | Customizes the initial empty state of the chatbot |
71+
| `emptyState.title` | `string` | No | Main heading shown before the first message |
72+
| `emptyState.description` | `string` | No | Subtext shown below the empty state title |

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@sqliteai/docs-chatbot",
33
"description": "Documentation search chatbot powered by SQLite and AI",
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"license": "MIT",
66
"type": "module",
77
"main": "./dist/cjs/index.cjs.js",

0 commit comments

Comments
 (0)