Updated VueIS geosearch demo README (#371)

* Updated VueIS geosearch demo README * Update Vue InstantSearch/geo-search/README.md Co-authored-by: Haroen Viaene <[email protected]> * Update Vue InstantSearch/geo-search/README.md Co-authored-by: Haroen Viaene <[email protected]> Co-authored-by: Haroen Viaene <[email protected]>
algolia · Mar 17, 2022 · 6531a9b · 6531a9b
1 parent 988640b
commit 6531a9b
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 18 deletions.
diff --git a/Vue InstantSearch/geo-search/README.md b/Vue InstantSearch/geo-search/README.md
@@ -1,26 +1,39 @@
-# vue-instantsearch-v2-starter
+# Geo-search example with Vue InstantSearch and Google Maps
 
-## Project setup
-```
-yarn install
-```
+This example shows you how to add Geo search capabilities to your Vue InstantSearch implementation and displaying the found results via Google Maps.
 
-### Compiles and hot-reloads for development
-```
-yarn run serve
-```
+<p align="center"><img src="capture.jpg" alt="A capture of the Geo-search example with Vue InstantSearch and Google Maps demo" /></p>
 
-### Compiles and minifies for production
-```
-yarn run build
-```
+## Demo
 
-### Run your tests
-```
-yarn run test
+[Access the demo](https://codesandbox.io/s/github/algolia/doc-code-samples/tree/master/Vue%20InstantSearch/geo-search)
+
+## How to run this example locally
+
+### 1. Clone this repository
+
+```sh
+git clone [email protected]:algolia/doc-code-samples.git
 ```
 
-### Lints and fixes files
+### 2. Install the dependencies and run the server
+
+```sh
+cd Vue InstantSearch/geo-search
+yarn
+yarn serve
 ```
-yarn run lint
+
+Alternatively, you may use npm:
+
+```sh
+cd Vue InstantSearch/geo-search
+npm
+npm serve
 ```
+
+Open <http://localhost:8080> to see your app.
+
+## Additional resources
+Learn more [Geo Search with Vue InstantSearch](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/geo-search/vue/) in the Algolia documentation.
+
diff --git a/Vue InstantSearch/geo-search/capture.jpg b/Vue InstantSearch/geo-search/capture.jpg