From 89032569b6eb78da9d123fe6e6612eff171b5c4e Mon Sep 17 00:00:00 2001
From: Felix Buehler <account@buehler.rocks>
Date: Wed, 15 Jun 2022 21:14:59 +0200
Subject: [PATCH] have a new README reflecting flake changes

---
 README.md        | 46 ++++++++++++++++++++++++++--------------------
 legacy/README.md | 27 +++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 20 deletions(-)
 create mode 100644 legacy/README.md

diff --git a/README.md b/README.md
index 5bc6df8..ec46a5f 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,33 @@
-# My personal NixOS-configuration
-work in progress...
+# nixos-config [![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)
 
-get internet
-`wpa_passphrase "<SSID>" > /etc/wpa_supplicant.conf`
-`systemctl restart wpa_supplicant`
+This repository holds my NixOS configuration. It is fully reproducible, flakes
+based, and position-independent, meaning there is no moving around of
+`configuration.nix`.
 
-install git
-`nix-env -iA nixos.git`
+Deployment is done using [deploy-rs](https://github.com/serokell/deploy-rs), see [usage](#usage).
+Secret are managed using [sops-nix](https://github.com/Mic92/sops-nix).
 
-get this repo
-`git clone https://github.com/Stunkymonkey/nixos.git`
-`cd nixos`
+## structure
 
-link to correct host
-`ln -s <host>.nix configuration.nix`
+```
+.
+├── nixos        # Machine definitions
+└── legacy       # older scripts kept before having an iso-image
+```
 
-set password for luks
-`vim /tmp/password`
-enter password
-`head -c <#char> /tmp/password > /tmp/passwd`
+## usage
 
-install
-`bash install-<hostname>.sh`
+updating:
+```bash
+nix flake update
+```
 
-wait + enter password
-`reboot`
+deployment:
+```bash
+deploy .#myHost
+```
+
+secrets:
+```bash
+sops ./nixos/myHost/secrets.yaml
+```
diff --git a/legacy/README.md b/legacy/README.md
new file mode 100644
index 0000000..5bc6df8
--- /dev/null
+++ b/legacy/README.md
@@ -0,0 +1,27 @@
+# My personal NixOS-configuration
+work in progress...
+
+get internet
+`wpa_passphrase "<SSID>" > /etc/wpa_supplicant.conf`
+`systemctl restart wpa_supplicant`
+
+install git
+`nix-env -iA nixos.git`
+
+get this repo
+`git clone https://github.com/Stunkymonkey/nixos.git`
+`cd nixos`
+
+link to correct host
+`ln -s <host>.nix configuration.nix`
+
+set password for luks
+`vim /tmp/password`
+enter password
+`head -c <#char> /tmp/password > /tmp/passwd`
+
+install
+`bash install-<hostname>.sh`
+
+wait + enter password
+`reboot`