From 2f92f046758bc633100556f20f73003d934bab88 Mon Sep 17 00:00:00 2001
From: Fabrice Aneche <akh@inair.space>
Date: Thu, 12 Mar 2020 11:27:41 -0400
Subject: [PATCH] docs

---
 README.md | 59 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 32 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index ee9f02d..dd8c795 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,42 @@
 # kvtiles
 
-kvtiles is a web server to embed and serve maps.
+kvtiles is a web server to embed and serve maps. Free map for all!
+
+Regions are precomputed, simply pull the image and you are good to go.
 
 Using the MVT format extracted from MBTiles, kvtiles is using a key value storage to speed up queries.
 
 In short this project provides [self hosted map tiles](https://blog.nobugware.com/post/2019/self_hosted_world_maps/). 
 
-## Usage
+
+## Docker & Kubernetes
+
+Main goal of kvtiles is to be run in Docker/Kubernetes.
+
+You can browse all the different regions and levels via [kvtiles docker tags](https://hub.docker.com/r/akhenakh/kvtiles/tags)
+
+```
+ docker run --rm -it -p 8080:8080 akhenakh/kvtiles:us-9-latest
+```
+
+Then point your browser to `http://yourdockerip:8080/static/`
+
+An example deployment for kubernetes is located in `cmd/kvtilesd`.
+
+## APIs
+
+Tiles are available at `/tiles/{z:[0-9]+}/{x:[0-9]+}/{y:[0-9]+}.pbf`, an optional `key` URL param can be passed to secure access to your tiles server, (use the `tilesKey` option).
+
+Metrics are provided via Prometheus at `http://host:httpMetricsPort/metrics`.
+
+A debug visual map is available at `http://host:httpAPIPort/static/`.
+
+Health status is provided via gRPC `host:healthPort` or via HTTP `http://host:httpAPIPort/healthz`.
+
+A `http://host:httpAPIPort/version` is giving you running version but also information on the dataset.
+
+
+## Application usage
 
 To transform an MBTiles into an embedded DB use `mbtilestokv`
 ```
@@ -31,28 +61,3 @@ Usage of ./cmd/kvtilesd/kvtilesd:
   -tilesKey="": A key to protect your tiles access
 ```
 
-## APIs
-
-Tiles are available at `/tiles/{z:[0-9]+}/{x:[0-9]+}/{y:[0-9]+}.pbf`, an optional `key` URL param can be passed to secure access to your tiles server, (use the `tilesKey` option).
-
-Metrics are provided via Prometheus at `http://host:httpMetricsPort/metrics`.
-
-A debug visual map is available at `http://host:httpAPIPort/static/`.
-
-Health status is provided via gRPC `host:healthPort` or via HTTP `http://host:httpAPIPort/healthz`.
-
-A `http://host:httpAPIPort/version` is giving you running version but also information on the dataset.
-
-## Docker & Kubernetes
-
-Main goal of kvtiles is to be run in Docker/Kubernetes with embedded maps.
-
-A demo with Hawaii can be run:
-
-```
- docker run --rm -it -p 8080:8080 akhenakh/kvtiles-demo:latest
-```
-
-Then point your browser to `http://yourdockerip:8080/static/`
-
-An example deployment for kub is located in `cmd/kvtilesd`.