From 798556599456b4d1fa4a130d74141ee4c110dd2e Mon Sep 17 00:00:00 2001 From: Yasha Mostofi Date: Wed, 1 Mar 2017 12:48:07 -0600 Subject: [PATCH] updated README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f792ebc..db8c59f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # effective-goggles -staff app for people to be able to log in and scan QR codes at the event +Effective Goggles is a (very simple) iOS app that allows event hosts to track participants for certain events. + +This is designed to work with the [HackIllinois API](https://github.com/HackIllinois/api-2017). This is the current flow: + +- An API admin sets up a Universally Tracked event (within the iOS app) that has a name and a duration. Currently, the UI checks the role in the JWT token that the API returns to determine if the logged in user can access the "new event" page. +- The API will begin tracking that event, and only allows each user to "participate" once. "Participation" is defined as a POST to the `/v1/tracking/:id` endpoint, where `id` is the user ID embedded in the QR code. +- Effective Goggles allows hosts to scan user's QR codes and the app will indicate if it is their first time participating in the currently tracked event. + +Build/usage instructions TBD. +