Initial checkin
This commit is contained in:
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# s3-genindex
|
||||
|
||||
Generate HTML directory indexes with file type icons and responsive design.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
go install git.ipng.ch/ipng/s3-genindex/cmd/s3-genindex@latest
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Generate index.html in current directory
|
||||
s3-genindex
|
||||
|
||||
# Generate recursively with custom output
|
||||
s3-genindex -r -o listing.html /path/to/dir
|
||||
|
||||
# Exclude files by regex
|
||||
s3-genindex -x "(build|node_modules|\.tmp)"
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
make build
|
||||
make test
|
||||
```
|
||||
|
||||
See [docs/DETAILS.md](docs/DETAILS.md) for complete documentation.
|
||||
Reference in New Issue
Block a user