potato/autopilot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ian Adam Naval 2019-01-22 00:16:14 -05:00
parent 3aea6dd8e7
commit 851b57a7e7
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -5,20 +5,30 @@ Scheduling automation for East Coast Aero Club's flight scheduling software.
## Features ## Features
* Sync with Google calendar * Sync with Google calendar
* Automatically schedule desired flight
## Setup ## Setup
```bash ```bash
pipenv install # install python deps
cp .env.example .env cp .env.example .env
$EDITOR .env # add your config $EDITOR .env # add your config
make build
``` ```
## Usage ## Usage
Run locally with Docker:
```bash ```bash
source .env make run
python -m autopilot.app
``` ```
## 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!