Skip to content

Commit

Permalink
chore: mention next version in README (#1413)
Browse files Browse the repository at this point in the history
Co-authored-by: Haroen Viaene <hello@haroen.me>
  • Loading branch information
shortcuts and Haroenv committed Jul 13, 2022
1 parent 5e4dad5 commit 100d180
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
- **UMD compatible**, you can use it with any module loader
- Built with TypeScript

## ⏭ Next

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.

## 💡 Getting Started

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

```js
const algoliasearch = require("algoliasearch");
const algoliasearch = require('algoliasearch');

const client = algoliasearch("YourApplicationID", "YourAdminAPIKey");
const index = client.initIndex("your_index_name");
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
const index = client.initIndex('your_index_name');

const objects = [
{
objectID: 1,
name: "Foo"
}
name: 'Foo',
},
];

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

```js
index
.search("Fo")
.search('Fo')
.then(({ hits }) => {
console.log(hits);
})
Expand Down

0 comments on commit 100d180

Please sign in to comment.