diff --git a/README.md b/README.md index b59bb1c1..61d115d0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ # 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. + +### Usage + +*Not functional yet* + +Simply start up a web server and access the Maputnik editor GUI at `localhost:8000`. + +``` +maputnik +``` + +Expose a local style file to Maputnik allowing the web based editor +to save to the local filesystem. + +``` +maputnik --file basic-v9.json +``` + +Watch the local style for changes and inform the editor via web socket. +This makes it possible to edit the style with a local text editor and still +use Maputnik. + +``` +maputnik --watch --file basic-v9.json +``` ### Build