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
|
## 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!
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user