From 15b14b30c02e1488f32cc6bc3bf791449b7cd6ec Mon Sep 17 00:00:00 2001 From: Fawad Mirzad Date: Sun, 14 Feb 2021 15:26:01 +0100 Subject: [PATCH] Update readme --- README.md | 69 ++++++++++++++++++++++++------------------------------- 1 file changed, 30 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 0232d6b..4172407 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ npm install -S @fawmi/vue-google-maps ## Basic usage You need an API Key. Learn how to [get an Api key ](https://developers.google.com/maps/documentation/javascript/get-api-key). -##Configure Vue to use the Components +### Configure Vue to use the Components In your `main.js` or inside a Nuxt plugin: @@ -33,17 +33,17 @@ app.use(VueGoogleMaps, { }).mount('#app') ``` -## Use it anywhere in your components +### Use it anywhere in your components ```vue ``` +## Components ### Markers -If you need to gain access to the `Map` instance (e.g. to call `panToBounds`, `panTo`): +If you need to add markers to the `Map`, add `GMapMarker` as child of `GMapMap` component. ```vue ``` + ### Cluster -If you have too many markers, it is helpfull to cluster markers. You can easily cluster maps by wrapping your markers with Cluster component. +If you have too many markers, it is helpful to cluster markers. You can easily cluster markers by wrapping your markers with `GMapCluster` component. ```vue ``` -If you need to gain access to the `google` object, you can access it by getting ref of the map object. + +Checkout docs for more component + +## Access map object +If you want to access `google map` object, you can access it by getting ref of the map object. ```vue