Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dpmcmlxxvi committed Jun 15, 2019
1 parent 0b8c99c commit ec2beef
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 22 deletions.
Binary file modified docs/api/docs/web/img/olexp-example-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 18 additions & 10 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,24 @@
<a href="https://coveralls.io/github/dpmcmlxxvi/olexp?branch=master"><img src="https://img.shields.io/coveralls/dpmcmlxxvi/olexp/master.svg" alt="coverage"></a>
<a href="https://www.codacy.com/app/dpmcmlxxvi/olexp?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=dpmcmlxxvi/olexp&amp;utm_campaign=Badge_Grade"><img src="https://img.shields.io/codacy/grade/df098e3d833a44a3af028f712c4ee75e/master.svg" alt="codacy"></a>
<a href="https://badge.fury.io/js/olexp"><img src="https://badge.fury.io/js/olexp.svg" alt="npm"></a>
<a href="https://david-dm.org/dpmcmlxxvi/olexp"><img src="https://img.shields.io/david/dpmcmlxxvi/olexp.svg" alt="dependencies"></a>
<a href="https://david-dm.org/dpmcmlxxvi/olexp/master#info=devDependencies"><img src="https://img.shields.io/david/dev/dpmcmlxxvi/olexp/master.svg" alt="devdependencies"></a>
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/dpmcmlxxvi/olexp.svg" alt="Greenkeeper"></a>
<a href="http://gruntjs.com/"><img src="https://cdn.gruntjs.com/builtwith.png" alt="grunt"></a></p>
<p>OpenLayers Explorer (olexp) is a Javascript library that combines the mapping
power of <a href="http://openlayers.org/">OpenLayers</a> and the layout management of
<a href="http://w2ui.com">w2ui</a>. The olexp library can be used to create web
applications to explore spatial data. The library provides an out-of-the-box
solution to display map content along with easy-to-use common interface tools -
a layer manager and a toolbar.</p>
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/dpmcmlxxvi/olexp.svg" alt="greenkeeper"></a></p>
<p>OpenLayers Explorer (olexp) is a simple out-of-the-box web mapping solution.
It provides a viewer to easily add, visualize, and analyze spatial data. It
provides the following common tools:</p>
<ul>
<li><strong>Toolbar</strong> with standard tools (e.g., measuring tools).</li>
<li><strong>Outline</strong> to inspect and control the visible layers and overlays.</li>
<li><strong>Map</strong> to display raster tiles, vectors, and overlays.</li>
</ul>
<p>It's a Javascript library that combines the mapping power of
<a href="http://openlayers.org/">OpenLayers</a> and the layout management of
<a href="http://w2ui.com">w2ui</a>. An explorer can be created easily by creating a <code>div</code>
element and provding it's <code>id</code> to the <code>olexp.Explorer</code> constructor as follows:</p>
<pre class="prettyprint source lang-html"><code>&lt;div id=&quot;explorer&quot; style=&quot;height: 500px; width: 500px;&quot;>&lt;/div>
&lt;script>
const explorer = new olexp.Explorer('explorer');
&lt;/script>
</code></pre>
<p><img src="docs/web/img/olexp-example-screenshot.png" alt=""></p>
<h2>DOCUMENTATION</h2>
<p>The following help is available at the olexp
Expand Down
2 changes: 1 addition & 1 deletion docs/api/quicksearch.html

Large diffs are not rendered by default.

Binary file modified docs/web/img/olexp-example-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 21 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,27 @@
[![coverage](https://img.shields.io/coveralls/dpmcmlxxvi/olexp/master.svg)](https://coveralls.io/github/dpmcmlxxvi/olexp?branch=master)
[![codacy](https://img.shields.io/codacy/grade/df098e3d833a44a3af028f712c4ee75e/master.svg)](https://www.codacy.com/app/dpmcmlxxvi/olexp?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=dpmcmlxxvi/olexp&amp;utm_campaign=Badge_Grade)
[![npm](https://badge.fury.io/js/olexp.svg)](https://badge.fury.io/js/olexp)
[![dependencies](https://img.shields.io/david/dpmcmlxxvi/olexp.svg)](https://david-dm.org/dpmcmlxxvi/olexp)
[![devdependencies](https://img.shields.io/david/dev/dpmcmlxxvi/olexp/master.svg)](https://david-dm.org/dpmcmlxxvi/olexp/master#info=devDependencies)
[![Greenkeeper](https://badges.greenkeeper.io/dpmcmlxxvi/olexp.svg)](https://greenkeeper.io/)
[![grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)

OpenLayers Explorer (olexp) is a Javascript library that combines the mapping
power of [OpenLayers](http://openlayers.org/) and the layout management of
[w2ui](http://w2ui.com). The olexp library can be used to create web
applications to explore spatial data. The library provides an out-of-the-box
solution to display map content along with easy-to-use common interface tools -
a layer manager and a toolbar.
[![greenkeeper](https://badges.greenkeeper.io/dpmcmlxxvi/olexp.svg)](https://greenkeeper.io/)

OpenLayers Explorer (olexp) is a simple out-of-the-box web mapping solution.
It provides a viewer to easily add, visualize, and analyze spatial data. It
provides the following common tools:

- **Toolbar** with standard tools (e.g., measuring tools).
- **Outline** to inspect and control the visible layers and overlays.
- **Map** to display raster tiles, vectors, and overlays.

It's a Javascript library that combines the mapping power of
[OpenLayers](http://openlayers.org/) and the layout management of
[w2ui](http://w2ui.com). An explorer can be created easily by creating a `div`
element and provding it's `id` to the `olexp.Explorer` constructor as follows:

```html
<div id="explorer" style="height: 500px; width: 500px;"></div>
<script>
const explorer = new olexp.Explorer('explorer');
</script>
```

![](docs/web/img/olexp-example-screenshot.png)

Expand Down

0 comments on commit ec2beef

Please sign in to comment.