From e16cbad454c3864f77f1b28ad2d4e57388b500ea Mon Sep 17 00:00:00 2001 From: suroh Date: Wed, 13 Sep 2023 17:10:26 +0200 Subject: [PATCH] updated README to incorporate dev/design desires --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 426d425..24ba04e 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,29 @@ An interactive map tool. A tool for collaborative planning on maps. Anyone can c ## Install Ethermap is built in JavaScript (soz) using NodeJS. Install instructinos for the back and frontend are in their respective folders. + +## Desires + +Minimal viable functionality for this project is the following : + +- Anyone can create a map +- Anyone can create, modify and delete points on a map that contain at least + - name of point + - notes on said point +- Everyone can see current users _live_ + - users can choose their name + - users can choose their cursor colour + - user data should be remembered across visits + +Things that ethermap should/could do in the future : + +- points + - edits are all recorded +- users + - users can chat + - users can also draw polygons and make labels that are not necessarily "points of interest" +- notes + - notes should be rich + - note updates should also be "live" + - notes should be attributed to users who wrote/edited them +- _osmAnd Sync!_