From 2135c5016080d370510fd73ffe1c54ef60142a8b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= <joerg@thalheim.io>
Date: Wed, 5 Jul 2023 16:10:04 +0200
Subject: [PATCH] add README on how to use repo

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dc3801c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# clan-infra
+
+This repository contains nixos modules and terraform code that powers clan.lol.
+The website and git hosting is currently on [hetzner](https://www.hetzner.com/).
+
+## Servers
+
+- web01:
+  - Instance type: CPX42
+  - CPU: 8 vCPUs on AMD
+  - RAM: 16GB
+  - Drives: 80GB SSD
+
+## To deploy new ssh keys on hcloud:
+
+```
+$ cd ./targets/admins
+$ ./tf.sh apply
+```
+
+## To deploy a server i.e. web01:
+
+```
+$ cd ./targets/web01
+$ ./tf.sh apply
+```
+
+## To update the website
+
+```
+$ cd ./targets/web01
+$ nix flake lock --update-input homepage --commit-lock-file
+$ ./tf.sh apply
+```