ashatora/editor
1
0
Fork 0
mirror of https://github.com/maputnik/editor.git synced 2026-02-08 05:30:00 +00:00
Code Issues Projects Releases Wiki Activity

Extend README with endpoint desription

Browse Source
This commit is contained in:
lukasmartinelli
2016-11-05 17:40:19 +01:00
parent 009f4e105d
commit 11375008fa
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -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