From 11375008facd06578116363a3a17de0098167d0a Mon Sep 17 00:00:00 2001 From: lukasmartinelli Date: Sat, 5 Nov 2016 17:40:19 +0100 Subject: [PATCH] Extend README with endpoint desription --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59f5c0ca..10481eb9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # Maputnik Desktop [![Build Status](https://travis-ci.org/maputnik/desktop.svg?branch=master)](https://travis-ci.org/maputnik/desktop) A Golang based cross platform executable for integrating Maputnik locally. -The idea is to package up the JavaScript and CSS bundle produced by [maputnik/editor](https://github.com/maputnik/desktop) -and embed it in the server program. +This binary packages up the JavaScript and CSS bundle produced by [maputnik/editor](https://github.com/maputnik/desktop) +and embeds it in the program for easy distribution. It also allows +exposing a local style file and work on it both in Maputnik and with your favorite +editor. ### Usage @@ -29,6 +31,17 @@ use Maputnik. maputnik --watch --file basic-v9.json ``` +### API + +`maputnik` exposes the configured styles via a HTTP API. + +| Method | Description +|---------------------------------|--------------------------------------- +| `GET /files` | List all configured style files +| `GET /files/{filename}` | Get contents of a single style file +| `PUT GET /files/{filename}` | Update contents of a style file +| `WEBSOCKET /ws` | Listen to change events for the configured style files + ### Build Clone the repository **recursively** since the Maputnik editor is embedded