diff --git a/README.md b/README.md index af3fbf0..37aeb3a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,33 @@
It's Free Real Estate
-**Vacansee** is a interactive heatmap that shows students what rooms and facilities are/will be available based on data scraped from schedules (SIS), booking services (EMS), and wifi telemetry (`rpi_wpa2`). + + + + +### What is it? + + +**Vacansee** is an interactive (heat)map for displaying live stats on rooms/facilities @ RPI. + +This includes: +- Expected building occupancy and foot traffic +- Active/upcoming classes & where to find them +- Printer availability +- What dining halls are serving, and for how long +- —and more to come! + +We intend to become the de facto one-stop-shop for event discovery, occupancy tracking, and general navigation on campus. +{{ interpretHeat() }} ({{ getBldg().meta.heat }}%)
+{{ interpretHeat() }} (~{{ getBldg().meta.heat.toFixed(2)*100 }}%)
+N/A
++ {{ interpretFlow() }} (~{{ getBldg().meta.flow.toFixed(2)*100 }}%)
{{ getRealTime(global.time) }}
- +{{ getData().meta.cur[0] }} ends in +
{{ getRoom().meta.cur[0] }} ends in {{ getCur().hours() }}h and {{ getCur().minutes() }}m - for section{{(getSecs('cur') > 1) ? 's':''}} - {{ item }} + for section{{(getSecs('cur') > 1) ? 's ':' '}} + {{ item }}
No class in session
-Next class ({{ getData().meta.next[0] }}) starts in +
Next class ({{ getRoom().meta.next[0] }}) starts in {{ getNext().hours() }}h and {{ getNext().minutes() }}m - for section{{(getSecs('next') > 1) ? 's':''}} - {{ item }} + for section{{(getSecs('next') > 1) ? 's ':' '}} + {{ item }}
No more classes this week