diff --git a/README.md b/README.md index a60b7a0..aa1eec0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # EventMapper -EventMapper, an easily-deployable, nearly-static digital guide application made in JavaScript. +EventMapper, a lightweight (hopefully), easily-deployable, nearly-static digital mapping application made for mobile in JavaScript. ## Specifications @@ -11,6 +11,7 @@ EventMapper, an easily-deployable, nearly-static digital guide application made /rooms [FLOOR].json floors.json +tags.json ``` ### Floor @@ -43,6 +44,7 @@ This object gets represented in the app as a map poly. [x, y], // An array of vertex positions. ... ], + "tags": ["[ARRAY", "OF", "TAG", "IDS]"], "lang": { "[IETF LANGUAGE TAG]": { "name": "[SINGLE-LINE STRING]", @@ -55,7 +57,7 @@ This object gets represented in the app as a map poly. This will be stored in an array in `rooms/[FLOOR].json` to be accessed by clients. ### Event -Used to represent a point in time when an activity or festivity happens. It is a child to both a [Floor](#floor) and a [Room](#room), reflected in its ID. +Used to represent a point in time when an activity happens. It is a child to both a [Floor](#floor) and a [Room](#room), reflected in its ID. ```json { "id": "[FLOOR]_[ROOM]_[EVENT ID]", @@ -63,13 +65,35 @@ Used to represent a point in time when an activity or festivity happens. It is a "start": "[ISO 8601 DATE]", "end": "[ISO 8601 DATE]" }, + "tags": ["[ARRAY", "OF", "TAG", "IDS]"], "lang": { "[IETF LANGUAGE TAG]": { "name": "[SINGLE-LINE STRING]", "description": "[MULTI-LINE STRING]", - "url": "[URL]" + "host": "[HOST NAME (OPTIONAL)]" } } } ``` -This will be stored in an array in `events/[FLOOR].json` to be accessed by clients. \ No newline at end of file +This will be stored in an array in `events/[FLOOR].json` to be accessed by clients. + +### Tag +Used to represent a tag that can be applied by ID to a Room or Event. +This object gets represented in the app as a searchable tag chip. +`radiogroup` can be used to un-toggle other tags when this one is selected. +`show` can be used to hide the tag from search completely. +```json +{ + "id": "[FLOOR ID]", + "radiogroup": "[GROUP ID]", + "show": , + "lang": { + "[IETF LANGUAGE TAG]": { + "name": "[SHORT SINGLE-LINE STRING]", + "shortName": "[INITIALS OF NAME]", + "description": "[SINGLE-LINE STRING]" + } + } +} +``` +This will be stored in an array in `tags.json` to be accessed by clients. \ No newline at end of file