From 26086fe3cd28d2effd5599b85edffc9c624949a6 Mon Sep 17 00:00:00 2001
From: Max Resnick <max@ofmax.li>
Date: Sun, 16 Feb 2025 10:21:47 -0800
Subject: docs: update readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c17a1b3..74861ce 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
 # git-snapshot
 
-A stupid script that snapshots a git repo via bundle and uploads to an object store.
+A command-line tool for backing up git repositories to Amazon S3.
+
+## Features
+
+- Backs up multiple git repositories to S3 using git bundles
+- Tracks backup state using checkpoint tags
+- Write-ahead logging (WAL) for backup operations
+- Only creates new backups when changes are detected
+- Configurable S3 bucket and prefix paths
+
+## Usage
+
+```bash
+gitsnap backup <repositories-dir> <s3-bucket> [-p PREFIX]
+```
+
+Where:
+- `repositories-dir`: Directory containing git repositories to backup
+- `s3-bucket`: Name of the S3 bucket for storing backups
+- `-p, --prefix`: Optional prefix for objects in S3 (default: 'gitsnap')
+
+## Requirements
+
+- Python 3
+- boto3
+- sh
-- 
cgit v1.2.3