Skip to content

Commit

Permalink
[UPD] rename ol3-ext to ol-ext
Browse files Browse the repository at this point in the history
  • Loading branch information
Viglino committed Dec 24, 2017
1 parent 4912589 commit 0052a9d
Show file tree
Hide file tree
Showing 12 changed files with 16,449 additions and 30 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,8 @@ bar.addControl (c);
```
- add `autoActive` option to `ol.control.Toggle` to auto activate the control when inserted in a subbar
- add `autoDeactivate` option to `ol.control.Bar` to auto deactivate all controls in a subbar when desactivating it

## v1.1.2 2017-12
**change project name ol-ext is now ol-ext**
- add doc-pages [#53]
- see [#65]
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# ol3-ext
# ol-ext
*Cool extensions for [OpenLayers](https://github.com/openlayers/openlayers) (ol/ol3/ol4)*.

[ol3-ext](https://github.com/Viglino/ol3-ext) is a set of extensions, controls, interactions to use with Openlayers.
[View live examples online](http://viglino.github.io/ol3-ext/) or the [API documentation](http://viglino.github.io/ol3-ext/doc/doc-pages/).
### ol3-ext is now [ol-ext](https://github.com/Viglino/ol-ext) update your bookmark and your code

[ol-ext](https://github.com/Viglino/ol-ext) is a set of extensions, controls, interactions to use with Openlayers.
[View live examples online](http://viglino.github.io/ol-ext/) or the [API documentation](http://viglino.github.io/ol-ext/doc/doc-pages/).

**Keywords:** CSS popup,
Font Awesome symbol renderer,
Expand Down Expand Up @@ -32,20 +34,20 @@ animations
![](img/map.overlay.magnify.jpg?raw=true)
![](img/map.filter.lego.jpg?raw=true)
![](img/map.interaction.synchronize.jpg?raw=true)
](http://viglino.github.io/ol3-ext/)
](http://viglino.github.io/ol-ext/)

## Getting Started

* Just download the [build script](https://github.com/Viglino/ol3-ext/tree/gh-pages/dist) in the dist directory of the project.
* Just download the [build script](https://github.com/Viglino/ol-ext/tree/gh-pages/dist) in the dist directory of the project.
* If you just want to add a `<script>` tag to test things out, you can link directly to the builds from the github rawgit (not recommended in production):
````
<!-- OL3-ext -->
<link rel="stylesheet" href="https://cdn.rawgit.com/Viglino/ol3-ext/gh-pages/dist/ol3-ext.min.css" />
<script type="text/javascript" src="https://cdn.rawgit.com/Viglino/ol3-ext/gh-pages/dist/ol3-ext.min.js"></script>
<!-- OL-ext -->
<link rel="stylesheet" href="https://cdn.rawgit.com/Viglino/ol-ext/gh-pages/dist/ol-ext.min.css" />
<script type="text/javascript" src="https://cdn.rawgit.com/Viglino/ol-ext/gh-pages/dist/ol-ext.min.js"></script>
````
* Use npm [ol3-ext package](https://www.npmjs.com/package/ol3-ext):
* Use npm [ol-ext package](https://www.npmjs.com/package/ol-ext):
````
npm install ol3-ext
npm install ol-ext
````

#### Building the project:
Expand All @@ -56,26 +58,26 @@ gulp

## Documentation

Check out the [hosted examples](http://viglino.github.io/ol3-ext/) or the [API documentation](http://viglino.github.io/ol3-ext/doc/doc-pages/).
Check out the [hosted examples](http://viglino.github.io/ol-ext/) or the [API documentation](http://viglino.github.io/ol-ext/doc/doc-pages/).

#### Building the documenctation:
The documentation use [gulp-jsdoc3](https://www.npmjs.com/package/gulp-jsdoc3) to create the doc.
1. install the gulp-jsdoc3 project at the root directory:
````
npm install gulp-jsdoc3
````
2. then run the gulp command to create the doc in the [doc/doc-pages](http://viglino.github.io/ol3-ext/doc/doc-pages/) directory:
2. then run the gulp command to create the doc in the [doc/doc-pages](http://viglino.github.io/ol-ext/doc/doc-pages/) directory:
````
gulp doc
````

## Bugs

Please use the [GitHub issue tracker](https://github.com/Viglino/ol3-ext/issues) for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.
Please use the [GitHub issue tracker](https://github.com/Viglino/ol-ext/issues) for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.

## Licence

ol3-ext is licenced under the French Opensource **BSD** compatible CeCILL-B FREE SOFTWARE LICENSE.
ol-ext is licenced under the French Opensource **BSD** compatible CeCILL-B FREE SOFTWARE LICENSE.
(c) 2016-2017 - Jean-Marc Viglino

Some resources (mapping services and API) used in this sofware may have a specific license.
Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "viglino/ol3-ext",
"description": "Cool extensions for OpenLayers 3",
"name": "viglino/ol-ext",
"description": "Cool extensions for OpenLayers (ol)",
"license": "CeCILL-B",
"authors": [
{
Expand Down
1,997 changes: 1,997 additions & 0 deletions dist/ol-ext.css

Large diffs are not rendered by default.

Loading

0 comments on commit 0052a9d

Please sign in to comment.