diff --git a/README.md b/README.md index 9423cf5..dfb4b96 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,46 @@ +![tileserver-gl](https://cloud.githubusercontent.com/assets/59284/18173467/fa3aa2ca-7069-11e6-86b1-0f1266befeb6.jpeg) + + # TileServer GL [![Build Status](https://travis-ci.org/klokantech/tileserver-gl.svg?branch=master)](https://travis-ci.org/klokantech/tileserver-gl) [![Docker Hub](https://img.shields.io/badge/docker-hub-blue.svg)](https://hub.docker.com/r/klokantech/tileserver-gl/) -Vector and raster maps with GL styles. Map tile server for Mapbox Android, iOS, GL JS, Leaflet, OpenLayers, GIS via WMTS, etc. Server side rendering by Mapbox GL Native. +Vector and raster maps with GL styles. Server side rendering by Mapbox GL Native. Map tile server for Mapbox GL JS, Android, iOS, Leaflet, OpenLayers, GIS via WMTS, etc. -## Quickstart -Use `npm install -g tileserver-gl` to install the package from npm. +## Get Started -Then you can simply run `tileserver-gl zurich_switzerland.mbtiles` to start the server for the given mbtiles. +Install `tileserver-gl` with server-side raster rendering of vector tiles with npm -Or you can use `docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl` to run the server inside a docker container. +```bash +npm install -g tileserver-gl +``` -Alternatively, you can use `tileserver-gl-light` package instead, which is pure javascript (does not have any native dependencies) and can run anywhere, but does not contain rasterization features. +Now download vector tiles from [OSM2VectorTiles](http://osm2vectortiles.org/downloads/). -Prepared vector tiles can be downloaded from [OSM2VectorTiles](http://osm2vectortiles.org/). +```bash +curl -o zurich_switzerland.mbtiles https://osm2vectortiles-downloads.os.zhdk.cloud.switch.ch/v2.0/extracts/zurich_switzerland.mbtiles +``` + +Start `tileserver-gl` with the downloaded vector tiles. + +```bash +tileserver-gl zurich_switzerland.mbtiles +``` + +Alternatively, you can use the `tileserver-gl-light` package instead, which is pure javascript (does not have any native dependencies) and can run anywhere, but does not contain rasterization on the server side made with MapBox GL Native. + +## Using Docker + +An alternative to npm to start the packed software easier is to install [Docker](http://www.docker.com/) on your computer and then run in the directory with the downloaded MBTiles the command: + +```bash +docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl +``` + +This will download and start a ready to use container on your computer and the maps are going to be available in webbrowser on localhost:8080. + +On laptop you can use [Docker Kitematic](https://kitematic.com/) and search "tileserver-gl" and run it, then drop in the 'data' folder the MBTiles. ## Documentation -You can read full documentation of this project at http://tileserver.readthedocs.io/. \ No newline at end of file + +You can read full documentation of this project at http://tileserver.readthedocs.io/.