From ff9d5a8e5dc512912da8528fab675a721c75ce23 Mon Sep 17 00:00:00 2001 From: Petr Sloup Date: Thu, 25 Aug 2016 12:52:32 +0200 Subject: [PATCH] Update READMEs and descriptions --- README.md | 5 +++-- README_light.md | 17 +++++++++++++++++ package.json | 2 +- publish.js | 2 ++ 4 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 README_light.md diff --git a/README.md b/README.md index 93145e8..9423cf5 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,17 @@ [![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. ## Quickstart Use `npm install -g tileserver-gl` to install the package from npm. Then you can simply run `tileserver-gl zurich_switzerland.mbtiles` to start the server for the given mbtiles. -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. - Or you can use `docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl` to run the server inside a docker container. +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. + Prepared vector tiles can be downloaded from [OSM2VectorTiles](http://osm2vectortiles.org/). ## Documentation diff --git a/README_light.md b/README_light.md new file mode 100644 index 0000000..f31745d --- /dev/null +++ b/README_light.md @@ -0,0 +1,17 @@ +# TileServer GL light +[![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 maps with GL styles. Map tile server for Mapbox Android, iOS, GL JS, Leaflet, OpenLayers, etc. without server side rendering. + +## Quickstart +Use `npm install -g tileserver-gl-light` to install the package from npm. + +Then you can simply run `tileserver-gl-light zurich_switzerland.mbtiles` to start the server for the given mbtiles. + +See also `tileserver-gl` which contains server side rendering. + +Prepared vector tiles can be downloaded from [OSM2VectorTiles](http://osm2vectortiles.org/). + +## Documentation +You can read full documentation of this project at http://tileserver.readthedocs.io/. \ No newline at end of file diff --git a/package.json b/package.json index d074e4d..6adbe9a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "tileserver-gl", "version": "1.1.0", - "description": "Map tile server for JSON GL styles - serverside generated raster tiles", + "description": "Map tile server for JSON GL styles - vector and server side generated raster tiles", "main": "src/main.js", "bin": "src/main.js", "authors": [ diff --git a/publish.js b/publish.js index 9938393..f9bc19d 100644 --- a/publish.js +++ b/publish.js @@ -20,6 +20,7 @@ var fs = require('fs'); var packageJson = require('./package'); packageJson.name += '-light'; +packageJson.description = 'Map tile server for JSON GL styles - serving vector tiles'; delete packageJson.dependencies['canvas']; delete packageJson.dependencies['mapbox-gl-native']; delete packageJson.dependencies['node-pngquant-native']; @@ -29,6 +30,7 @@ delete packageJson.devDependencies; var str = JSON.stringify(packageJson, undefined, 2); fs.writeFileSync('light/package.json', str); +fs.renameSync('light/README_light.md', 'light/README.md'); /* PUBLISH */