add a brief readme
This commit is contained in:
parent
54d0db577c
commit
3028bb6b39
14
README.md
14
README.md
|
@ -1,3 +1,17 @@
|
|||
# sfs
|
||||
|
||||
## Static File Server
|
||||
|
||||
Extremely minimal static file server and indexer. HTTP-only. Bring your own reverse proxy, reverse tunnel, etc.
|
||||
|
||||
## Installation
|
||||
|
||||
Clone. Install npm dependencies. Optionally symlink to `sfs` from somewhere in your `PATH`.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
sfs <port> [host]
|
||||
```
|
||||
|
||||
Starts a server on the given `port` for the current working directory. Binds to localhost only unless `host` is specified.
|
||||
|
|
Loading…
Reference in New Issue