valsor / instantsearch.js Goto Github PK

Looking for instantsearch.js instead? Go to the develop branch.

This is the main README of the InstantSearch project.

Currently we support React and plain JavaScript (or Vanilla) via:

• ⚛ React and React Native ➡️ React InstantSearch
• 🍦 Vanilla ➡️ InstantSearch.js

This current branch (v2) holds the code for React InstantSearch, see project status for more information on project structure.

React InstantSearch is available in the npm registry. Install it:

yarn add react-instantsearch

Note: we use yarn to install dependencies but React InstantSearch is also installable via npm.

Detailed info on how to use InstantSearch can be found in the documentation website

We welcome all contributors, from beginner to advanced. You are only one command away to start the developer environement, read our CONTRIBUTING guide.

InstantSearch.js was our first instant-search related project. We still support the current version (v1.x.x) of it. And you can still count on contributors to fix bugs.

In a near future this current repository will hold any instant-search related project:

• InstantSearch Core
• InstantSearch.js v2 (based on React InstantSearch)
• InstantSearch Vue
• InstantSearch Angular
• …

While we are in transition mode, the v2 branch is the main development branch for any of the upcoming projects.

The develop branch will soon be renamed v1 and v2 will be the new develop as soon as we have instantsearch.js v2.