From bb75997e3e9129934b49d71e0606b499927d9903 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ng=C6=B0=CC=83=20Quang=20Tr=C6=B0=C6=A1ng?= Date: Fri, 11 Sep 2020 01:42:28 +0700 Subject: [PATCH] Update README.md Changes: - Update the README to clarify that the part `Including Mapbox GL JS` is not under the part `Vue CDN`. Context: I have trouble to install the package because I miss the part `Including Mapbox GL JS`. I don't have expertise in frontend stuff so I misunderstood that this part is a part of Vue CDN way. I see others have the same trouble too, [1](https://github.com/phegman/vue-mapbox-gl/issues/62) and [2] (https://github.com/phegman/vue-mapbox-gl/issues/1). --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ec37289..edcda67 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,22 @@ A simple lightweight (9kb/3kb gzipped) Mapbox GL JS Vue component. ## Installation -### Yarn +### Step 1. Add the package +To add the new package, use one of the following ways. + +#### Yarn ```bash yarn add mapbox-gl-vue ``` -### NPM +#### NPM ```bash npm install mapbox-gl-vue --save ``` -### [Vue CDN](https://vuejs.org/v2/guide/#Getting-Started) +#### [Vue CDN](https://vuejs.org/v2/guide/#Getting-Started) Download latest `vue-mapbox-gl.min.js` from [https://github.com/phegman/vue-mapbox-gl/releases](https://github.com/phegman/vue-mapbox-gl/releases) @@ -36,7 +39,7 @@ Include using a ` ``` -### Including Mapbox GL JS +### Step 2. Including Mapbox GL JS This package does not include the Mapbox GL JS and CSS files. See Mapbox GL JS installation guide here: [https://www.mapbox.com/install/js/](https://www.mapbox.com/install/js/)