Skip to content

Commit 441cef0

Browse files
fix: update readme
1 parent f74199f commit 441cef0

2 files changed

Lines changed: 11 additions & 13 deletions

File tree

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@ DocSearch crawls your documentation, pushes the content to an Algolia index and
2222

2323
## Preview
2424

25-
![Screencast](.github/screencast.gif)
26-
27-
| Light | Dark |
28-
| --- | --- |
29-
| ![Light preview](.github/preview-light.png) | ![Dark preview](.github/preview-dark.png) |
25+
<video loop="true" muted="true" playsInline="true" autoPlay="true" preload="auto">
26+
<source src="packages/website/static/img/resources/askai720p.mp4" type="video/mp4" />
27+
</video>
3028

3129
## Usage
3230

@@ -37,15 +35,15 @@ DocSearch crawls your documentation, pushes the content to an Algolia index and
3735
#### Installation
3836

3937
```sh
40-
yarn add @docsearch/js@beta
38+
yarn add @docsearch/js@4
4139
# or
42-
npm install @docsearch/js@beta
40+
npm install @docsearch/js@4
4341
```
4442

4543
If you don’t want to use a package manager, you can use a standalone endpoint:
4644

4745
```html
48-
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@beta"></script>
46+
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@4"></script>
4947
```
5048

5149
#### Get started
@@ -78,15 +76,15 @@ docsearch({
7876
#### Installation
7977

8078
```bash
81-
yarn add @docsearch/react@beta
79+
yarn add @docsearch/react@4
8280
# or
83-
npm install @docsearch/react@beta
81+
npm install @docsearch/react@4
8482
```
8583

8684
If you don’t want to use a package manager, you can use a standalone endpoint:
8785

8886
```html
89-
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@beta"></script>
87+
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@4"></script>
9088
```
9189

9290
#### Get started
@@ -102,8 +100,8 @@ function App() {
102100
return (
103101
<DocSearch
104102
appId="YOUR_APP_ID"
105-
indexName="YOUR_INDEX_NAME"
106103
apiKey="YOUR_SEARCH_API_KEY"
104+
indices=["YOUR_ALGOLIA_INDEX"]
107105
/>
108106
);
109107
}

packages/website/docusaurus.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ export default {
128128
announcementBar: {
129129
id: 'announcement-bar',
130130
content:
131-
'🚀 Use AskAI Now! Turn your docs site search into an AI-powered assistant – faster answers, fewer tickets, better self-serve. <a target="_blank" rel="noopener noreferrer" href="https://dashboard.algolia.com/ask-ai">Get Started Now</a>',
131+
'🚀 Get AskAI now! Turn your docs site search into an AI-powered assistant – faster answers, fewer tickets, better self-serve. <a target="_blank" rel="noopener noreferrer" href="https://dashboard.algolia.com/ask-ai">Get Started Now</a>',
132132
},
133133
colorMode: {
134134
defaultMode: 'light',

0 commit comments

Comments
 (0)