Clean up and add LICENSE section to README.md
This commit is contained in:
parent
5e2be10434
commit
3d5c55498f
20
README.md
20
README.md
@ -1,9 +1,17 @@
|
|||||||
# imgupload
|
# 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?
|
### What is imgupload?
|
||||||
imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests.
|
imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
1. Clone the repository: `git clone https://gitea.bbaovanc.com/bbaovanc/imgupload.git`
|
1. Clone the repository: `git clone https://gitea.bbaovanc.com/bbaovanc/imgupload.git`
|
||||||
2. Enter the imgupload directory: `cd imgupload`
|
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`
|
5. Install dependencies: `python3 -m pip install -r requirements.txt`
|
||||||
6. Run the Flask app
|
6. Run the Flask app
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Running the Flask app
|
## Running the Flask app
|
||||||
|
|
||||||
### Using uWSGI
|
### Using uWSGI
|
||||||
[https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)
|
[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
|
Instructions specific to imgupload are coming soon
|
||||||
|
|
||||||
### Using Flask development server
|
### Using Flask development server
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ source env/bin/activate # if you haven't already entered the virtualenv
|
$ source env/bin/activate # if you haven't already entered the virtualenv
|
||||||
$ export FLASK_APP=imgupload.py
|
$ export FLASK_APP=imgupload.py
|
||||||
$ flask run
|
$ 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)
|
||||||
|
Reference in New Issue
Block a user