Skip to content

Commit

Permalink
release v0.11.0
Browse files Browse the repository at this point in the history
update readme and docs
  • Loading branch information
ghettovoice committed Nov 25, 2018
1 parent 2f7adc7 commit 4491549
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 32 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ It can display maps with tiled, raster or vector layers loaded from different so

## Versions

**NOTE**: you are reading README for latest version **v0.11.x** that is based on the **OpenLayers v5**.
To use VueLayers with **OpenLayers v4** go to the [**v0.10.x**](https://github.com/ghettovoice/vuelayers/tree/stable-0.10.x) branch.
**NOTE**: you are reading README for the next version **v0.12.x**.

- [master](https://github.com/ghettovoice/vuelayers/tree/master) - This is the branch for the current **>=v0.11.x (OpenLayers >=5)** version
- [stable-0.10.x](https://github.com/ghettovoice/vuelayers/tree/stable-0.10.x) - This is the branch for the previous **v0.10.x (OpenLayers <5)** version
| Vuelayers | Branch | Vue | OpenLayers |
| :------------------ | :--------------------------------------------------------------------------- | :------ | :--------- |
| Current **0.11.x** | [stable-0.11.x](https://github.com/ghettovoice/vuelayers/tree/stable-0.11.x) | **2.3** | **5.x** |
| Next **0.12.x** | [master](https://github.com/ghettovoice/vuelayers/tree/master) | **2.3** | **5.x** |
| Previous **0.10.x** | [stable-0.10.x](https://github.com/ghettovoice/vuelayers/tree/stable-0.10.x) | **2.3** | **4.x** |

## Links

Expand All @@ -37,14 +39,20 @@ To use VueLayers with **OpenLayers v4** go to the [**v0.10.x**](https://github.c

## Requirements

- [Vue](https://vuejs.org/) version **^2.3**.
- [OpenLayers](https://openlayers.org/) version **^5.0**.
- [Vue](https://vuejs.org/) version **^2.3**
- [OpenLayers](https://openlayers.org/) version **^5.0**

## Install

```bash
# install Vue and VueLayers
npm install -S vue vuelayers
# install Vue
npm install vue

# install current VueLayers version
npm install vuelayers

# install next VueLayers version
npm install vuelayers@next
```

## Build Setup
Expand Down
16 changes: 8 additions & 8 deletions docs/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ See the [Quick start](quickstart.md "Quick start guide") for more details how to

## Versions

**NOTE**: you are reading README for latest version **v0.11.x** that is based on the **OpenLayers v5**.
To use VueLayers with **OpenLayers v4** go to the [**v0.10.x**](https://github.com/ghettovoice/vuelayers/tree/stable-0.10.x) branch.

- [master](https://github.com/ghettovoice/vuelayers/tree/master) - This is the branch for the current **>=v0.11.x (OpenLayers >=5)** version
- [stable-0.10.x](https://github.com/ghettovoice/vuelayers/tree/stable-0.10.x) - This is the branch for the previous **v0.10.x (OpenLayers <5)** version
| Vuelayers | Branch | Vue | OpenLayers |
| :------------------ | :--------------------------------------------------------------------------- | :------ | :--------- |
| Current **0.11.x** | [stable-0.11.x](https://github.com/ghettovoice/vuelayers/tree/stable-0.11.x) | **2.3** | **5.x** |
| Next **0.12.x** | [master](https://github.com/ghettovoice/vuelayers/tree/master) | **2.3** | **5.x** |
| Previous **0.10.x** | [stable-0.10.x](https://github.com/ghettovoice/vuelayers/tree/stable-0.10.x) | **2.3** | **4.x** |

## Features

* Display raster, vector, tiled layers
* Draw and modify vector features
* Easy to extend with the help of multiple mixins
* UMD / CommonJS / ES6 build versions
* UMD / ES6 build versions

## Requirements

- [Vue](https://vuejs.org/) version **^2.3**.
- [OpenLayers](https://openlayers.org/) version **^5.0**.
- [Vue](https://vuejs.org/) version **^2.3**
- [OpenLayers](https://openlayers.org/) version **^5.0**

## Live demo

Expand Down
16 changes: 2 additions & 14 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Quick start

VueLayers distributed as a set of separated components and mixins built as **CommonJS** and **ES2015** modules.
VueLayers distributed as a set of separated components and mixins built as **ES2015** modules.
For in browser usage there is full standalone **UMD** bundle provided.

## Installation

!> VueLayers works with Vue.js **2.3+** and OpenLayers **3.14+**
!> VueLayers works with Vue.js **2.3+** and OpenLayers **5.0+**

### NPM

Expand Down Expand Up @@ -42,15 +42,6 @@ You can browse the source of the npm package at [unpkg.com/vuelayers/](https://u
</script>
```

**Compressed files** are also available

```html
<!-- include optimized UMD VueLayers build -->
<link rel="stylesheet" href="https://unpkg.com/vuelayers/lib/style.min.css">
<script src="https://unpkg.com/vuelayers/lib/index.umd.min.js"></script>
```


### Build from source

!> Node **v6+** is required
Expand All @@ -65,9 +56,6 @@ npm install

# build all targets
npm run build
# or only what you need, --format argument accepts list of target formats
# separated by comma (es, cjs, umd)
npm run rollup -- --format es,cjs

# check lib dir, there are all ready to use components
ls -l lib
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "vuelayers",
"fullname": "VueLayers",
"version": "0.11.0-rc.7",
"version": "0.11.0",
"description": "Web map Vue components with the power of OpenLayers",
"author": "Vladimir Vershinin <ghettovoice@gmail.com>",
"main": "./lib/index.js",
Expand Down

0 comments on commit 4491549

Please sign in to comment.