add a brief readme
This commit is contained in:
parent
a31ab51301
commit
c6fe04c6f0
16
README.md
16
README.md
|
@ -1,3 +1,19 @@
|
||||||
# sfu
|
# sfu
|
||||||
|
|
||||||
## Simple File Uploader
|
## Simple File Uploader
|
||||||
|
|
||||||
|
Extremely minimal HTML form file uploader. HTTP-only. Bring your own reverse proxy, reverse tunnel, etc.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Clone. Install npm dependencies. Optionally symlink to `sfu` from somewhere in your `PATH`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
sfu <port> [host]
|
||||||
|
```
|
||||||
|
|
||||||
|
Starts a server on the given `port`. Binds to localhost only unless `host` is specified.
|
||||||
|
|
||||||
|
Each upload can contain multiple files and will be saved in a directory with a randomly generated name in the current working directory.
|
||||||
|
|
Loading…
Reference in New Issue