Skip to content

Commit 100d180

Browse files
shortcutsHaroenv
andauthored
chore: mention next version in README (#1413)
Co-authored-by: Haroen Viaene <[email protected]>
1 parent 5e4dad5 commit 100d180

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@
3434
- **UMD compatible**, you can use it with any module loader
3535
- Built with TypeScript
3636

37+
## ⏭ Next
38+
39+
The [`next` branch](https://github.com/algolia/algoliasearch-client-javascript/tree/next) hosts the code of the new major version (`v5`). This version is generated from the [`API Clients Automation` monorepo](https://github.com/algolia/api-clients-automation/) which is where you can follow the development and make contributions.
40+
3741
## 💡 Getting Started
3842

3943
First, install Algolia JavaScript API Client via the [npm](https://www.npmjs.com/get-npm) package manager:
@@ -45,16 +49,16 @@ npm install algoliasearch
4549
Then, create objects on your index:
4650

4751
```js
48-
const algoliasearch = require("algoliasearch");
52+
const algoliasearch = require('algoliasearch');
4953

50-
const client = algoliasearch("YourApplicationID", "YourAdminAPIKey");
51-
const index = client.initIndex("your_index_name");
54+
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
55+
const index = client.initIndex('your_index_name');
5256

5357
const objects = [
5458
{
5559
objectID: 1,
56-
name: "Foo"
57-
}
60+
name: 'Foo',
61+
},
5862
];
5963

6064
index
@@ -71,7 +75,7 @@ Finally, let's actually search using the `search` method:
7175

7276
```js
7377
index
74-
.search("Fo")
78+
.search('Fo')
7579
.then(({ hits }) => {
7680
console.log(hits);
7781
})

0 commit comments

Comments
 (0)