fix: update docs for props & import links

vinayakkulkarni · Jun 17, 2020 · 463593a · 463593a
1 parent b61a807
commit 463593a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/docs/guide/README.md b/docs/guide/README.md
@@ -4,10 +4,10 @@
 
 ### Installation
 
-You can install vue-mapbox via npm. Take note that you need to install mapbox-gl as peer dependency:
+You can install v-mapbox via npm. Take note that you need to install mapbox-gl as peer dependency:
 
 ```bash
-npm install --save vue-mapbox mapbox-gl
+npm install --save v-mapbox mapbox-gl
 ```
 
 Add mapbox CSS file to `<head></head>` block of your HTML file (e.g. `index.html`)
@@ -23,7 +23,7 @@ Add mapbox CSS file to `<head></head>` block of your HTML file (e.g. `index.html
 
 ### Installation
 
-Add Vue, MapboxGL and Vue-mapbox scripts on your page:
+Add Vue, MapboxGL and v-mapbox scripts on your page:
 
 ```html
 <!DOCTYPE html>
@@ -32,22 +32,22 @@ Add Vue, MapboxGL and Vue-mapbox scripts on your page:
     <!-- ... -->
     <!-- Mapbox GL CSS -->
     <link
-      href="https://api.tiles.mapbox.com/mapbox-gl-js/v0.53.0/mapbox-gl.css"
+      href="https://api.tiles.mapbox.com/mapbox-gl-js/v1.11.0/mapbox-gl.css"
       rel="stylesheet"
     />
-    <!-- Vue-mapbox CSS -->
+    <!-- v-mapbox CSS -->
     <link
-      href="https://cdn.jsdelivr.net/npm/vue-mapbox@latest/dist/vue-mapbox.css"
+      href="https://cdn.jsdelivr.net/npm/v-mapbox@latest/dist/v-mapbox.css"
       rel="stylesheet"
     />
     <!-- Mapbox GL JS -->
-    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v0.53.0/mapbox-gl.js"></script>
+    <script src="https://api.tiles.mapbox.com/mapbox-gl-js/v1.11.0/mapbox-gl.js"></script>
     <!-- VueJS -->
     <script src="https://cdn.jsdelivr.net/npm/vue@latest/dist/vue.min.js"></script>
-    <!-- Vue-mapbox -->
+    <!-- v-mapbox -->
     <script
       type="text/javascript"
-      src="https://cdn.jsdelivr.net/npm/vue-mapbox@latest/dist/vue-mapbox.min.js"
+      src="https://cdn.jsdelivr.net/npm/v-mapbox@latest/dist/v-mapbox.min.js"
     ></script>
     <!-- ... -->
   </head>
@@ -63,7 +63,7 @@ In version `0.2` you don't need to register VueMapbox as Vue plugin.
 So you don't need this code anymore:
 
 ```js
-import VueMapbox from "vue-mapbox";
+import VueMapbox from "v-mapbox";
 import Mapbox from "mapbox-gl";
 
 Vue.use(VueMapbox, { mapboxgl: Mapbox });

diff --git a/docs/guide/basemap.md b/docs/guide/basemap.md
@@ -13,7 +13,7 @@ If you using self-hosting maps on your own server you can omit this parameter.
 
 <script>
 import Mapbox from "mapbox-gl";
-import { MglMap } from "vue-mapbox";
+import { MglMap } from "v-mapbox";
 
 export default {
   components: {
@@ -41,9 +41,9 @@ Example:
 ```vue
 <template>
   <MglMap
-    :mapboxGl="mapbox-gl"
-    :accessToken="accessToken"
-    :mapStyle.sync="mapStyle"
+    :mapbox-gl="mapbox-gl"
+    :access-token="accessToken"
+    :map-style.sync="mapStyle"
     @load="onMapLoaded"
   />
 </template>
@@ -72,8 +72,8 @@ If you want to store map object, store it as non-reactive property like in examp
 ```vue
 <template>
   <MglMap
-    :accessToken="accessToken"
-    :mapStyle.sync="mapStyle"
+    :access-token="accessToken"
+    :map-style.sync="mapStyle"
     @load="onMapLoaded"
   />
 </template>