[![Vue InstantSearch logo][logo]][website]

InstantSearch projects: **Vue InstantSearch**
| [InstantSearch.js][instantsearch.js-github]
| [React InstantSearch][react-instantsearch-github]
| [Angular InstantSearch][angular-instantsearch-github]
| [InstantSearch Android][instantsearch-android-github]
| [InstantSearch iOS][instantsearch-ios-github].

## Vue InstantSearch

> ⚡ Lightning-fast search for Vue.js apps

Built by [Algolia][algolia-website].

This repository holds the code for the Vue InstantSearch project.

## Documentation

There's a dedicated documentation available at [www.algolia.com/doc/guides/building-search-ui/getting-started/vue][website].

## Installation

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

```sh
# with npm
npm install --save vue-instantsearch

# with yarn
yarn add vue-instantsearch
```

To learn more about the usage, follow our [getting started guide][getting-started-guide].

## Contributing, dev, release

We welcome all contributors, from casual to regular. You are only
one command away to start the developer environment,
[read our CONTRIBUTING guide](.github/CONTRIBUTING.md).

[logo]: .github/vue-instantsearch-readme.png
[website]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/
[getting-started-guide]: https://www.algolia.com/doc/guides/building-search-ui/getting-started/vue/
[algolia-website]: https://www.algolia.com/
[instantsearch.js-github]: https://github.com/algolia/instantsearch.js
[react-instantsearch-github]: https://github.com/algolia/react-instantsearch
[instantsearch-android-github]: https://github.com/algolia/instantsearch-android
[instantsearch-ios-github]: https://github.com/algolia/instantsearch-ios
[angular-instantsearch-github]: https://github.com/algolia/angular-instantsearch