Skip to content

Commit

Permalink
Production readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JanPetr committed Aug 1, 2016
1 parent b89cfcf commit eda3ecc
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 8 deletions.
52 changes: 44 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,47 @@
### This project is under active development
Algolia Search for Magento
==================

- **Do not use it for production**
- **No support from Algolia will be provided for the moment**, you can of course contribute by submitting PR
[Algolia Search](http://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.

This extension replaces the default search of Magento with a typo-tolerant, fast & relevant search experience backed by Algolia. It's based on [algoliasearch-client-php](https://github.com/algolia/algoliasearch-client-php), [autocomplete.js](https://github.com/algolia/autocomplete.js) and [instantsearch.js](https://github.com/algolia/instantsearch.js).

See features and benefits of [Algolia Search Extension for Magento](https://community.algolia.com/magento).

![Latest version](https://img.shields.io/badge/latest-0.8.0-green.svg)
![PHP >= 5.5.22](https://img.shields.io/badge/php-%3E=5.5.22-green.svg)

Documentation
--------------

Check out our documentation on [community.algolia.com/magento](https://community.algolia.com/magento/m2-documentation/).

Installation
------------

The easiest way to install the extension is to use [Composer](https://getcomposer.org/).

Run the following commands:

- ```$ composer require algolia/algoliasearch-magento-2:dev-master```
- ```$ bin/magento module:enable Algolia_AlgoliaSearch```
- ```$ bin/magento setup:upgrade && bin/magento setup:static-content:deploy```

Demo
--------------

You can check out our [live demo](https://magento.algolia.com) of Magento 1 integration.
Magento 2 demo is coming!

### Auto-completion menu

Offer End-Users immediate access to your whole catalog from the dropdown menu, whatever your number of categories or attributes.

![demo](gifs/autocomplete.gif)

### Instant search results page

Have your search results page, navigation and pagination updated in realtime, after each keystroke.

![demo](gifs/instantsearch.gif)

### How to install

Run the following commands
- ```composer require algolia/algoliasearch-magento-2:dev-master```
- ```bin/magento module:enable Algolia_AlgoliaSearch```
- ```bin/magento setup:upgrade && bin/magento setup:static-content:deploy```
Binary file added gifs/autocomplete.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gifs/instantsearch.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit eda3ecc

Please sign in to comment.