diff --git a/README.md b/README.md index e6e84f9..14cbfd1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # SHOP API Simple API (still WIP) +## Requires: +1. Redis +Simple redis installation, no further configuration needed + +2. MariaDB (or MySQL) +Make sure a proper database is set up with `shop.sql` + +## Running: +Gunicorn is the simplest way to run this project +```sh +gunicorn -w 4 -b HOST:PORT main:app +``` + # Routes ## Hello World