aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Resnick <max@ofmax.li>2025-02-16 10:45:28 -0800
committerMax Resnick <max@ofmax.li>2025-02-16 10:45:28 -0800
commit5ad26b15d612aa85e552dd4a4eeece65399087f8 (patch)
tree04ccda301e50e98e2a393d3682bc1daf443700da
parentbdc6ec5ebc7454338ba7741d002196711f60dc6a (diff)
downloadgrumpy-containers-5ad26b15d612aa85e552dd4a4eeece65399087f8.tar.gz
docs: update docs
-rw-r--r--README.md28
1 files changed, 27 insertions, 1 deletions
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.