From 2942b48b87a08de1dab8ca23c66fc5ffa659c50b Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Fri, 5 Jul 2024 22:08:35 +0200
Subject: README: Add build and usage documentation

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

diff --git a/README.md b/README.md
index 9dca017..f9acd86 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
 # craft
 
 `craft` is a minimal build automation tool for Linux.
+
+## Build
+
+Executing the `build.sh` script inside the root of the craft source code will
+create the craft Linux executable. Only the `go` tool and a posix shell is
+required.
+
+## Usage
+
+Craft is used as a Git hook. It can be enabled for a given Git repository and
+hook by creating a symbolic link:
+
+```
+ln -s path/to/craft path/to/repository/.git/hooks/post-receive
+```
+
+Currently only the `post-receive` hook is supported. This can be performed also
+with a bare repository:
+
+```
+ln -s path/to/craft path/to/bare/repository.git/hooks/post-receive
+```
+
+Whenever such a repository received updates via `git push` craft will be
+executed and prints text to the console of the user who pushed the updates.
-- 
cgit v1.2.3-70-g09d2