Skip to content

Update README to clarify the installation process #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README to clarify the installation process #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -36,7 +39,7 @@ Include using a `<script>` tag
<script src="vue-mapbox-gl.min.js"></script>
```

### 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/)

Expand Down