jquery-typeahead/README.md

jQuery plugin that provides Typeahead (autocomplete) Search preview from Json object(s) via same domain Ajax request or cross domain Jsonp and offers data compression inside Local Storage. The plugin is built with a lot of options and callbacks to allow c

[![Build Status](https://travis-ci.org/running-coder/jquery-typeahead.svg?branch=develop&style=flat-square)](https://travis-ci.org/running-coder/jquery-typeahead)
[![npm:](https://img.shields.io/npm/v/jquery-typeahead.svg?style=flat-square)](https://www.npmjs.com/package/jquery-typeahead)
[![license:mit](https://img.shields.io/badge/license-mit-green.svg?style=flat-square)](#license)
[![Built with gulp](http://img.shields.io/badge/built%20with-gulp.js-red.svg?style=flat-square)](http://gulpjs.com/)

# jQuery Typeahead

The jQuery Typeahead plugin provides autocomplete preview on search inputs similar to google search with builtin options and deep customization.
It is a simple clientside library that will improve the user experience on your website search input!

The jQuery Typeahead plugin is released under the MIT License.

The complete documentation, demo and further instructions can be found at www.runningcoder.org

## Installation

    npm install jquery-typeahead

or

    yarn add jquery-typeahead

## Documentation

You can find the complete documentation on www.runningcoder.org/jquerytypeahead/documentation/

## Demos

www.runningcoder.org/jquerytypeahead/demo/

## Version Notes

www.runningcoder.org/jquerytypeahead/version/

## Pull Requests

Please consider these points before creating a new pull request

- Pull request should be made from `develop` to `develop` branch so it can be tested properly and not be directly available to download on the `master`.
  The `master` branch should be a copy of the latest released `tag` without any additional new code that has not been released
- Add a descriptive note along with the PR and examples
- Only submit the changed lines and not the whole file(s)
- Follow the same coding conversions