angular-instantsearch/README.md

Lightning-fast search for Angular apps, by Algolia.

> [!IMPORTANT]
> We are deprecating the Angular InstantSearch package. For more information and alternative solutions, see [Migrating from Angular InstantSearch](https://alg.li/angular-deprecation).

# Angular InstantSearch

> ⚡ Lightning-fast search for Angular apps, by [Algolia][algolia-website].

[![Version][version-svg]][package-url] [![Build Status][ci-badge]][ci-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

InstantSearch projects: **Angular InstantSearch** | [InstantSearch][instantsearch-github] (JS / React / Vue) | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github].

## Angular compatibility

Angular InstantSearch is **compatible with Angular 5 up until Angular 16**.

## Documentation

There's a dedicated documentation available on the [Algolia website][website].

## 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/angular/) where you will find answers for the most common issues and gotchas with the library.

## Contributing

To contribute to the library (code and documentation), [read our contribution guide](./CONTRIBUTING.md).

[website]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/angular/
[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
[ci-badge]: https://circleci.com/gh/algolia/angular-instantsearch.svg?style=svg
[ci-url]: https://circleci.com/gh/algolia/angular-instantsearch
[license-image]: http://img.shields.io/badge/license-MIT-green.svg?style=flat-square
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/angular-instantsearch.svg?style=flat-square
[downloads-url]: http://npm-stat.com/charts.html?package=angular-instantsearch
[version-svg]: https://img.shields.io/npm/v/angular-instantsearch.svg?style=flat-square
[package-url]: https://yarnpkg.com/en/package/angular-instantsearch