From 3ccf4ba24fd040c4a09c7bb94d3534cbcfa13f0b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= <joerg@thalheim.io>
Date: Thu, 14 Sep 2023 11:11:10 +0200
Subject: [PATCH] expand readme

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

diff --git a/README.md b/README.md
index 6d8b9a2..9b9c6cc 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,6 @@
 
 A nixos module to make buildbot a proper Nix-CI.
 
+For an example checkout the [example](./examples/default.nix) and the module descriptions for [master](./nix/master.nix) and [worker](./nix/worker.nix).
+
+This project is still in early stage and many APIs might change over time.