From ef89a0a94908405dc991c02a78ed6b84fba0926d Mon Sep 17 00:00:00 2001
From: Emelie Graven <emelie@graven.dev>
Date: Mon, 22 Nov 2021 15:20:32 +0100
Subject: [PATCH] Add sparse docs to readme

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

diff --git a/README.md b/README.md
index f8a2a26..193344c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,11 @@
 # nixos
 
+Automatic deployment of nixaalb.org nix hosts using [niv](https://github.com/nmattia/niv) and [nixus](https://github.com/Infinisil/nixus).
+
+Secrets are encrypted with [git-crypt](https://www.agwa.name/projects/git-crypt/). To access, ask an already existing gpg collaborator to add your key using `git-crypt add-gpg-user USERID` and push the automatically generated commit to the repo. Pull said commit yourself and then run `git-crypt unlock` to decrypt secrets.
+
+## Updating
+run `niv update` in `config/sources/`
+
+## Deploying
+run `nix-build deploy` and then `./result` if the derivation builds successfully.