=== Plugin Name ===
Contributors: jojaba
Tags: autocomplete, autocompletion, relevanssi
Requires at least: 4.0
Tested up to: 5.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Autocompletion functionality for WordPress search input when Relevanssi plugin is installed.

== Description ==

This plugin is meant to add the word autocomplete in search input field by using the index stored in Relevanssi database. So you have to [install first Relevanssi](https://wordpress.org/plugins/relevanssi/) (free or premium version) to have it to work.

The JS script used to accomplish the autocompletion work has been developed by [Lea Verou](http://lea.verou.me/) and is called [Awesomplete](https://leaverou.github.io/awesomplete "Go to the Awesomplete homepage"). It is very simple to set up, lightweight and accessible.


= List of functionalities =

* Settings available: styling, min characters typed to show the autocompletion box, max suggestions in autocompletion box.
* Get the Relevanssi Indexed words to have the autcompletion list
* Fast and lightweight
* English and french languages included

== Installation ==

1. Upload the plugin folder `/autocomplete-for-relevanssi/` to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Use the Settings->Autocomplete for Relevanssi screen to configure the plugin

== Frequently Asked Questions ==

= Could this plugin work without Relevanssi plugin installed? =

No, sorry.

= Is this plugin working for both free and premium Relevanssi plugin? =

Yes.

= Can the box also display a search results list? =

No sorry. For the moment it shows up only indexed words. But maybe the results list displaying feature will be added in a future version of Autocomplete for Relevanssi… ;) 

== Screenshots ==

1. The settings page
2. The suggestion box

== Changelog ==

= 0.1 =
*Initial release