From ffece6a235c873ca28b3a4b0c4f3f4b48d8070d8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= <joerg@thalheim.io>
Date: Thu, 23 Dec 2021 17:11:13 +0100
Subject: [PATCH] add docs

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

diff --git a/README.md b/README.md
index 6162588..50241e2 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,33 @@
 # **Retiolum tinc keys and hosts**
 
-## Contents
-1. [VPN Setup](#VPN-Setup)
-2. [SSH Setup](#SSH-Setup)
+## NixOS usage
+
+If you are a flake user:
+
+```nix
+{
+  inputs = {
+    retiolum.url = "git+https://git.thalheim.io/Mic92/retiolum";
+  };
+  outputs = { retiolum, ... }: {
+    # Than include `retiolum.nixosModules.retiolum` nixos module in your nixos configurations
+    # To add the retiolum ssl certificate include `retiolum.nixosModules.ca`
+  }
+}
+```
+
+First add your key to https://github.com/krebs/stockholm
+Mic92's stockholm fork will than update this repository itself.
+
+```nix
+{
+  # lookup the ipv6 address from the generated text file ./hosts
+  networking.retiolum.ipv6 = "42:0:3c46:70c7:8526:2adf:0000:0000";
+  # optional
+  # networking.retiolum.ipv4 = "10.240.0.0";
+}
+```
+
 
 ## VPN Setup
 1. Install **tinc** (e.g. Ubuntu : `sudo apt install tinc`, MacOS: `brew install tinc --devel`)