From 63235768261976efe0d9c825e69c44fff8c80e5d Mon Sep 17 00:00:00 2001
From: Oliver Davies <oliver@oliverdavies.uk>
Date: Thu, 4 Sep 2025 21:35:09 +0100
Subject: [PATCH] Update README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index af5b94f..c5e3e01 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
 # git-repo-updater
+
+`git-repo-updater` is an CLI program that finds and updates Git repositories in specified directories.
+
+## Configuration
+
+`git-repo-updater` is configurable using a configuration file at `~/.config/git-repo-updater/config.yaml`.
+
+For example:
+
+```yaml
+# The number of levels to search.
+depth: 3
+
+# A list of directories to search in.
+directories:
+  - ~/Code/code.oliverdavies.uk
+
+# A list of repositories to ignore and not update.
+ignored:
+  - ~/Code/github.com/nixos/nixpkgs
+```