diff --git a/README.md b/README.md index e376f0b..43f8175 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,22 @@ ### What is imgupload? imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests. -### Usage -Make sure you install the dependencies first. To do this, run `sudo python3 -m pip install -r requirements.txt`. -To deploy imgupload, run `flask run`. +### Installation +1. Clone the repository: `git clone https://github.com/BBaoVanC/imgupload.git` +2. Enter the imgupload directory: `cd imgupload` +3. Create a virtualenv: `python3 -m venv env` +4. Enter the virtualenv: `source env/bin/activate` +5. Install dependencies: `python3 -m pip install -r requirements.txt` +6. Run the Flask app + +### Running the Flask app +## Using uWSGI +[https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html) +Instructions specific to imgupload are coming soon + +## Using Flask development server +```shell +$ source env/bin/activate # if you haven't already entered the virtualenv +$ export FLASK_APP=imgupload.py +$ flask run +```