From 1a6f8ae45c1d67f8cc2e15bc77023fab87ff98a6 Mon Sep 17 00:00:00 2001
From: Stefan <git@stefn.co.uk>
Date: Fri, 6 Dec 2024 15:21:41 +0000
Subject: [PATCH] Finish README

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

diff --git a/README.md b/README.md
index 77329a4..67af873 100644
--- a/README.md
+++ b/README.md
@@ -33,3 +33,37 @@ In your Jekyll site's `flake.nix`:
       };
     };
 }
+```
+
+### Custom Configuration
+
+You can customize the build by providing your own Gemfile, lockfile, and gemset:
+
+```nix
+nix-jekyll-builder.lib.${system}.mkJekyllSite {
+  pname = "my-jekyll-site";
+  version = "1.0.0";  # optional
+  src = ./.;
+  gemfile = ./Gemfile;
+  lockfile = ./Gemfile.lock;
+  gemset = ./gemset.nix;
+}
+```
+
+### Generating gemset.nix
+
+```bash
+# In your project directory with Gemfile present
+nix-shell -p bundix --run "bundix -l"
+```
+
+##  Running Tests
+
+```nix
+nix run .#test
+```
+
+## Requirements
+
+- Nix with flakes enabled
+- Ruby gems specified in your Gemfile