diff --git a/README.md b/README.md index 9351629..442fef5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# staffing - A clientside staffing visualizer +# Staffing Visualiser +A simple clientside staffing visualiser written in Javascript. + +## Features +Write json file for an staffing to +- Fill both canvas per position and per controller automatically +- Each position and controller will get an unique color until the colors are exhausted +- Current time (LT) red line in the timeline + +## How to create staffing +1. Clone this repo +2. Open it in Visual Studio Code and "Go Live" in bottom right. This creates a webserver that will update each time you save the json, so it's easy to preview changes. +3. When happy, you may push or pull request the changes into the repo so it becomes live on staffing.vatsca.org