1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a984908
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# haxgit - Lightweight cgit Docker Container
+
+A complete, ready-to-run cgit solution with website and SSH access, packaged in Docker.
+
+## Features
+
+- Full cgit web interface
+- Integrated SSH server for git operations
+- Persistent storage for repositories and configuration
+- Pre-configured with sensible defaults
+- Lightweight Alpine Linux base
+
+## Quick Start
+
+
+Pull the image:
+
+```bash
+docker pull savagedot/haxgit
+```
+
+Run the container with:
+
+```bash
+docker run -d --rm \
+  --name docker_cgit \
+  -p 64801:80 -p 64822:22 \
+  -v $PWD/data/git:/home/git \
+  -v $PWD/data/repositories:/home/git/repositories \
+  -v $PWD/data/ssh:/etc/ssh \
+  -v $PWD/data/web:/var/www \
+  savagedot/haxgit
+```