indir/README.md

21 lines
644 B
Markdown

# indir
a nifty static file indexer
indir provides a nice, simple frontend for browsing your web directories!
heavily inspired by traditional file indexers provided by the likes of nginx
and apache, with some modern amenities on top :)
## usage
```sh
indir [--host address] [--port port] [--root http_root] directory
--help shows this help message
--host address hosts on the specified address
--port port hosts on the specified port
--root http_root hosts on the specified subdirectory, i.e. `/files/`
```
## to-do:
- [ ] directory header from readme file
- [ ] directory stylesheet overrides