From 851b57a7e79472346134a2291f8fde0c816a4348 Mon Sep 17 00:00:00 2001 From: Ian Adam Naval Date: Tue, 22 Jan 2019 00:16:14 -0500 Subject: [PATCH] Update README --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f7dbd5a..05f8cff 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,30 @@ Scheduling automation for East Coast Aero Club's flight scheduling software. ## Features * Sync with Google calendar -* Automatically schedule desired flight ## Setup ```bash -pipenv install # install python deps cp .env.example .env $EDITOR .env # add your config +make build ``` ## Usage +Run locally with Docker: + ```bash -source .env -python -m autopilot.app +make run ``` +## Roadmap + +- [ ] Proper caching/background scheduling for calendar building +- [ ] Automatically schedule recurring flights when available + - [ ] Email notifications on failure to schedule +- [ ] Multi-user support + +## Deployment + +Kubernetes files to come soon!