docs: update example

algolia · Mar 31, 2022 · 91940e5 · 91940e5
1 parent 9e749b4
commit 91940e5
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 3 deletions.
diff --git a/examples/html-templates/README.md b/examples/html-templates/README.md
@@ -0,0 +1,34 @@
+# Autocomplete with HTML templates example
+
+This example shows how to use HTML templates in Autocomplete.
+
+<p align="center"><img src="capture.png?raw=true" alt="A capture of the Autocomplete with HTML templates example" /></p>
+
+## Demo
+
+[Access the demo](https://codesandbox.io/s/github/algolia/autocomplete/tree/next/examples/html-templates)
+
+## How to run this example locally
+
+### 1. Clone this repository
+
+```sh
+git clone git@github.com:algolia/autocomplete.git
+```
+
+### 2. Install the dependencies and run the server
+
+```sh
+yarn
+yarn workspace @algolia/autocomplete-example-html-templates start
+```
+
+Alternatively, you may use npm:
+
+```sh
+cd examples/html-templates
+npm install
+npm start
+```
+
+Open <http://localhost:1234> to see your app.
diff --git a/examples/html-templates/capture.png b/examples/html-templates/capture.png
diff --git a/examples/html-templates/package.json b/examples/html-templates/package.json
@@ -1,16 +1,16 @@
 {
   "name": "@algolia/autocomplete-example-html-templates",
   "description": "Autocomplete example with HTML templates",
-  "version": "1.5.3",
+  "version": "1.5.6",
   "private": true,
   "license": "MIT",
   "scripts": {
     "build": "parcel build index.html",
     "start": "parcel index.html"
   },
   "dependencies": {
-    "@algolia/autocomplete-js": "1.5.3",
-    "@algolia/autocomplete-theme-classic": "1.5.3",
+    "@algolia/autocomplete-js": "1.5.6",
+    "@algolia/autocomplete-theme-classic": "1.5.6",
     "algoliasearch": "4.9.1"
   },
   "devDependencies": {