Skip to content

chore: mention next version in README #1413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 13, 2022
Merged

chore: mention next version in README #1413

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce29f4e
chore: mention `next` version in `README`
shortcuts Jul 12, 2022
7006e62
Update README.md
shortcuts Jul 12, 2022
655a492
Update README.md
shortcuts Jul 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
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