Add a readme

This commit is contained in:
Tim Schaub
2016-12-18 14:35:44 -07:00
parent 815af723ea
commit d20e9ca8df
2 changed files with 34 additions and 1 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "ol",
"version": "3.20.0-beta.1",
"version": "3.21.0-beta.1",
"description": "OpenLayers",
"main": "index.js",
"license": "BSD-2-Clause",

33
package/readme.md Normal file
View File

@@ -0,0 +1,33 @@
# `ol`
[OpenLayers](https://openlayers.org/) for CommonJS module loaders.
**Note: This is still a work in progress. Not yet ready for production.**
## Usage
Add the `ol` package as a dependency to your project.
npm install ol@beta --save
Require just what you need for your application:
```js
var OLMap = require('ol/Map');
var View = require('ol/View');
var TileLayer = require('ol/layer/Tile');
var OSM = require('ol/source/OSM');
var map = new OLMap({
target: 'map',
layers: [
new TileLayer({
source: new OSM()
})
],
view: new View({
center: [0, 0],
zoom: 2
})
});
```