Refresh README

This commit is contained in:
Pim van Pelt
2025-12-03 12:27:14 +01:00
parent 16fa899b91
commit 60a149b669
2 changed files with 218 additions and 58 deletions

View File

@@ -1,6 +1,17 @@
# s3-genindex
Generate HTML directory indexes with file type icons and responsive design.
Generate HTML directory indexes with file type icons and responsive design for local directories and S3-compatible storage.
This is particularly useful for S3 buckets that are publicly readable.
## Features
- **Local directory indexing** with recursive traversal
- **S3-compatible storage support** (MinIO, AWS S3, etc.)
- **Hierarchical directory structure** for S3 buckets
- **Responsive HTML design** with file type icons
- **Dry run mode** for testing
- **Flexible filtering** with glob patterns and regex exclusion
- **Hidden file control** and index.html visibility options
## Install
@@ -8,17 +19,20 @@ Generate HTML directory indexes with file type icons and responsive design.
go install git.ipng.ch/ipng/s3-genindex/cmd/s3-genindex@latest
```
## Usage
## Quick Start
```bash
# Generate index.html in current directory
s3-genindex
# Local directory
s3-genindex -d /path/to/dir
# Generate recursively with custom output
s3-genindex -r -o listing.html /path/to/dir
# S3 bucket (requires AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY)
s3-genindex -s3 http://minio.example.com:9000/bucket
# Exclude files by regex
s3-genindex -x "(build|node_modules|\.tmp)"
# Dry run to see what would be generated
s3-genindex -d /path/to/dir -n
# Show index.html files in listings
s3-genindex -d /path/to/dir -i
```
## Build
@@ -28,4 +42,4 @@ make build
make test
```
See [docs/DETAILS.md](docs/DETAILS.md) for complete documentation.
See [docs/DETAILS.md](docs/DETAILS.md) for complete documentation and examples.