From 3d5c55498f0ac5c0bd5e6759f7946ea525780b34 Mon Sep 17 00:00:00 2001 From: BBaoVanC Date: Sun, 6 Sep 2020 11:26:13 -0500 Subject: [PATCH] Clean up and add LICENSE section to README.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3b5834..9936b4e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # imgupload -![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/BBaoVanC/imgupload/master?color=purple) ![GitHub repo size](https://img.shields.io/github/repo-size/bbaovanc/imgupload?color=purple) ![GitHub All Releases](https://img.shields.io/github/downloads/bbaovanc/imgupload/total?color=purple) ![GitHub issues](https://img.shields.io/github/issues/bbaovanc/imgupload?color=purple) ![GitHub closed issues](https://img.shields.io/github/issues-closed/bbaovanc/imgupload?color=purple) ![GitHub](https://img.shields.io/github/license/bbaovanc/imgupload?color=purple) + +![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/BBaoVanC/imgupload/master?color=purple) +![GitHub repo size](https://img.shields.io/github/repo-size/bbaovanc/imgupload?color=purple) +![GitHub All Releases](https://img.shields.io/github/downloads/bbaovanc/imgupload/total?color=purple) +![GitHub issues](https://img.shields.io/github/issues/bbaovanc/imgupload?color=purple) +![GitHub closed issues](https://img.shields.io/github/issues-closed/bbaovanc/imgupload?color=purple) +![GitHub](https://img.shields.io/github/license/bbaovanc/imgupload?color=purple) ### What is imgupload? imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests. +--- + ### Installation 1. Clone the repository: `git clone https://gitea.bbaovanc.com/bbaovanc/imgupload.git` 2. Enter the imgupload directory: `cd imgupload` @@ -12,15 +20,25 @@ imgupload is a Flask + uWSGI application to serve as an all-purpose image/file u 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 ``` + +--- + +## License + +_imgupload_ is licensed under the GPLv3 license. For more information, please refer to [`LICENSE`](https://gitea.bbaovanc.com/bbaovanc/imgupload/src/branch/master/LICENSE)