From ea5f4528e070c671ffff7a476410f9e451c65bfe Mon Sep 17 00:00:00 2001 From: alvierahman90 Date: Wed, 25 Oct 2017 13:02:59 +0100 Subject: [PATCH] Update README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index c4e25c1..d90d979 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # uploadr Upload files to a server on your local network for faster and simpler file transfers across a network. + +## config +The config file for uploadr is very simple. It should be in a class called `uploadr` in a file called `config.py`. It should be valid python and the two options needed are `domain` and `port` which are both used for the creation of QR code links. The file can also be used as the config file for +gunicorn. Here is an example below: +```python +class uploadr: + domain = "example.com" + port = 8005 + +# gunicorn +bind = "0.0.0.0:" + uploadr.port +``` + +## dependencies +uploadr uses the following modules: + - `flask` + - `qrcode` + - `werkzeug` +