Update README
This commit is contained in:
parent
3aea6dd8e7
commit
851b57a7e7
18
README.md
18
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!
|
||||
|
Loading…
x
Reference in New Issue
Block a user