From 204bdb5ff37cac0979c5fe71471de2e78ba75e58 Mon Sep 17 00:00:00 2001
From: James Lyne <jim+github@not-null.co.uk>
Date: Thu, 17 Dec 2020 14:46:48 +0000
Subject: [PATCH] Add README.md

---
 README.md | 70 ++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 51 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 7502338..0cb6684 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,56 @@
-# dynmap
+# LiveAtlas
+A [Dynmap](https://github.com/webbukkit/dynmap) frontend for the modern web, built with [Vue.js](https://github.com/vuejs/vue) and typescript.
 
-## Project setup
-```
-npm install
-```
+LiveAtlas is a drop-in replacement for the original Dynmap frontend, which aims to provide a more modern interface and improved performance for busy maps.
 
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
+Development is ongoing, and there are some rough edges, but most of the Dynmap features used by a typical Minecraft server have been implemented.
 
-### Compiles and minifies for production
-```
-npm run build
-```
+## Supported Dynmap features
+- Viewing maps
+- Layers
+- Player markers
+- Custom markers, areas, circles and lines
+- Popups
+- Tile/some marker updates
+- Following players
+- Location control
+- Link control
+- Digital/time of day clock control
+- Logo controls
+- New urls (`#world;map;1,1,1,1`)
 
-### Lints and fixes files
-```
-npm run lint
-```
+## Not supported right now
+- Chat
+- Chat balloons
+- Login/register
+- Marker settings (show labels/min and max zoom)
+- Legacy urls (`?worldname=world&mapname=map&z=1&y=1&z=1`)
+- Inactivity timeout
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## Installation
+Using an [external webserver](https://github.com/webbukkit/dynmap/wiki/External-Webserver-Basics) is recommended.
+
+### External webserver
+1. Download the latest release.
+2. Extract into your webserver root. Any existing index.html should be overwritten.
+3. Clear any CDN caches you may have
+4. Done.
+
+### Default internal webserver
+1. Download the latest release.
+2. Extract into `plugins/dynmap/web`. The existing index.html should be overwritten.
+3. (Optional) Set index.html as readonly. This will prevent Dynmap overwriting it after every update.
+4. Clear any CDN caches you may have.
+5. Done.
+
+## Customisation
+The index.html file can be edited to add custom favicons, just like the original Dynmap.
+You are also free to build LiveAtlas yourself to make further changes.
+
+## Building
+First run `npm install` to install LiveAtlas dependencies. You can then either run `npm run serve` to start a local dev server, or `npm run build` to build.
+
+## Support
+If you find a bug, please create an issue with as must detail as possible. I'm working on this in my spare time, so fixes are on a best effort basis, but I'll eventually find time for them.
+
+Please do not contact the Dynmap team regarding any issue with LiveAtlas. They will be very upset.
\ No newline at end of file