Skip to content

Commit

Permalink
Add links
Browse files Browse the repository at this point in the history
  • Loading branch information
nilshoerrmann committed Nov 18, 2021
1 parent 05ab4b8 commit cc664f9
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![Kirby Tiles](.github/title.png)

**Tiles** is a plugin for [Kirby 3](https://getkirby.com) to serve basic vector map tiles (`.mbtiles`).
**Tiles** is a plugin for [Kirby 3](https://getkirby.com) to serve basic vector map tiles (`.mbtiles`). The plugin provides styles, tilejson and vector tiles that can be used with with [Maplibre](https://maplibre.org/maplibre-gl-js-docs/api/) or similar.

## Installation

Expand All @@ -20,22 +20,26 @@ git submodule add https://github.com/hananils/kirby-tiles.git site/plugins/tiles
composer require hananils/kirby-tiles
```

## File storage and routes
# File storage and routes

Upload your map style and your tiles using Kirby's files fields. The following routes are provided:

### Styles
## Styles

`/tiles/{{ parent.page }}/styles/{{ filename }}.json`

### TileJSON
## TileJSON

`/tiles/{{ parent.page }}/tilejson/{{ filename }}.json`

### Vector tiles
## Vector tiles

`/tiles/{{ parent.page }}/vector/{{ filename }}/{{ z }}/{{ x }}/{{ y }}.pbf`

# Creating styles and tiles

More information on how to create styles and generate tyles can be found at <https://openmaptiles.org>.

# License

This plugin is provided freely under the [MIT license](LICENSE.md) by [hana+nils · Büro für Gestaltung](https://hananils.de).
Expand Down

0 comments on commit cc664f9

Please sign in to comment.