update readme
This commit is contained in:
parent
3b64b2b978
commit
3c38fa2f7f
1 changed files with 7 additions and 21 deletions
28
README.md
28
README.md
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
a nifty static file indexer
|
||||
|
||||
indir provides a nice, simple frontend for browsing your web directories!
|
||||
indir provides a nice, simple web frontend for browsing your file directories!
|
||||
heavily inspired by traditional file indexers provided by the likes of nginx
|
||||
and apache, with some modern amenities on top :)
|
||||
|
||||
|
|
@ -18,23 +18,9 @@ indir [--host address] [--port port] [--root http_root] directory
|
|||
|
||||
## features
|
||||
|
||||
### file serving
|
||||
indir has the possibility of automatically serving an `index.html` instead of displaying the directory view!
|
||||
|
||||
### customization
|
||||
|
||||
#### readme
|
||||
drop a `README.md` into any directory and indir will render
|
||||
it below the file listing with full markdown support!
|
||||
|
||||
#### custom css
|
||||
using a 'index.css' file, you can customize the directory view!
|
||||
|
||||
---
|
||||
|
||||
## to-do:
|
||||
- [x] use templates instead of hard-coded HTML (i was lazy)
|
||||
- [x] directory header from readme file
|
||||
- [x] directory stylesheet overrides
|
||||
- [x] index.html serving support
|
||||
- [x] fix mime-types for browser file view
|
||||
- **index files:** if available, indir will prefer serving an `index.html` file
|
||||
instead of a directory listing.
|
||||
- **custom CSS:** indir will append the contents of a local `index.css` file to
|
||||
the default stylesheet, if applicable.
|
||||
- **readme files:** adding a `readme.md` file (case insensitive) will append
|
||||
its contents beneath the directory tree in rendered markdown.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue