Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ghettovoice committed Mar 23, 2017
1 parent 1f94f3a commit ef59661
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,14 @@ Plugin may be used as UMD module or ES2015 module:
// Use as ES2015 module (based on NPM package `ol`)
// imports source files as is from `ol-tilecache/src` directory
// assumes bundling with Webpack or Browserify
import Map from 'ol/map'
...
import * as tileCacheUrlFn from 'ol-tilecache'

// Use as CommonJS module (based on NPM package `openlayers`) without bundling
// imports UMD module from `ol-tilecache/dist/bundle.js`
// imports UMD module from `ol-tilecache/dist/bundle.js`
const ol = require('openlayers')
...
const tileCacheUrlFn = require('ol-tilecache')
```

Expand Down Expand Up @@ -101,6 +105,25 @@ const map = new Map({

```

### Build

```bash
git clone https://github.com/ghettovoice/ol-tilecache.git
npm install

# build UMD module
npm run build
npm run build-min
# or
npm run build-all

# run test app
npm start

# run unit tests
npm test
```

## License

MIT (c) 2016-2017, Vladimir Vershinin

0 comments on commit ef59661

Please sign in to comment.