vue-instantsearch/README.md

👀 Lightning-fast Algolia search for Vue apps

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Vue InstantSearch](#vue-instantsearch)
- [Documentation](#documentation)
- [Installation](#installation)
- [Troubleshooting](#troubleshooting)
- [Contributing, dev, release](#contributing-dev-release)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

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

InstantSearch projects: **Vue InstantSearch** | [InstantSearch.js][instantsearch-github] | [React InstantSearch][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].

## Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/guides/building-search-ui/troubleshooting/faq/vue/) where you will find answers for the most common issues and gotchas with the library.

## 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](CONTRIBUTING.md).

[logo]: 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-github]: https://github.com/algolia/instantsearch
[instantsearch-android-github]: https://github.com/algolia/instantsearch-android
[instantsearch-ios-github]: https://github.com/algolia/instantsearch-ios