Create README.md

This commit is contained in:
Simon Fortier 2018-06-07 10:01:33 -04:00 committed by GitHub
parent a2835bbbcf
commit 460357f183
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# OD-Database
Suggestions/concerns/PRs are welcome
## Installation
Assuming you have Python 3 and git installed:
```bash
git clone https://github.com/simon987/od-database
cd od-database
pip3 install -r requirements.txt
```
## Running
```bash
python3 app.py
```
You should be able to connect with your browser at `https://localhost:12345`
*_Note: For now, you need to have the appropriate SSL certificates (cert.pem & privkey.pem) in /certificates. There will
be an option to disable SSL very soon_