From 5ad26b15d612aa85e552dd4a4eeece65399087f8 Mon Sep 17 00:00:00 2001 From: Max Resnick Date: Sun, 16 Feb 2025 10:45:28 -0800 Subject: docs: update docs --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0787b9b..90fb0ef 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # Grumpy Containers -a collection of containers for everyday tasks +A collection of Docker containers for everyday tasks and services. + +## Available Containers + +- **base**: Base container image +- **cgit**: Web interface for git repositories +- **cluster**: Container orchestration tools +- **git-snapshot**: Git repository backup utility +- **gitolite**: Git hosting and access management +- **go-echo**: Simple Go echo server +- **pelican**: Static site generator +- **rclone**: Cloud storage sync tool +- **sally**: Configuration management tool +- **static-files**: Static file server + +## Usage + +Each container is located in its own directory under `src/` with its own Dockerfile and configuration. +See the individual container directories for specific usage instructions and configuration options. + +## Building + +Containers can be built using standard Docker build commands from their respective directories. + +## License + +This project is open source. See individual container directories for specific licensing details. -- cgit v1.2.3