From 996b1dd07745c9a55fa907fb1b5bf8a7039ff708 Mon Sep 17 00:00:00 2001
From: Ryan Yin <xiaoyin_c@qq.com>
Date: Sun, 18 Feb 2024 13:12:13 +0800
Subject: [PATCH] docs: README

---
 README.md                  | 12 +++++++-----
 hosts/kubernetes/README.md | 27 ++++++++++++++-------------
 2 files changed, 21 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index bb4d9f73..c6c20e71 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,13 @@
   </a>
 </p>
 
-This repository is home to the nix code that builds my systems.
+This repository is home to the nix code that builds my systems:
+
+1. NixOS Desktops: NixOS with home-manager, i3, hyprland, agenix, etc.
+2. macOS Desktops: nix-darwin with home-manager, zsh, kitty, etc. Share the same home-manager configuration with NixOS Desktops.
+3. NixOS Servers: virtual machines running on Proxmox, with various services, such as homepage, prometheus, grafana, etc.
+
+See [./hosts](./hosts) for details of each host.
 
 ## Why NixOS & Flakes?
 
@@ -75,10 +81,6 @@ See [./home/base/desktop/editors/neovim/](./home/base/desktop/editors/neovim/) f
 
 See [./home/base/desktop/editors/emacs/](./home/base/desktop/editors/emacs/) for details.
 
-## Hosts
-
-See [./hosts](./hosts) for details.
-
 ## Secrets Management
 
 See [./secrets](./secrets) for details.
diff --git a/hosts/kubernetes/README.md b/hosts/kubernetes/README.md
index 34998c8a..d8633d84 100644
--- a/hosts/kubernetes/README.md
+++ b/hosts/kubernetes/README.md
@@ -2,21 +2,22 @@
 
 > WIP, not finished yet.
 
+I'm running two Kubernetes clusters, one for production and one for testing.
+
+I prefer to use [k3s] as the Kubernetes distribution, because it's lightweight, easy to install, and full featured(see [what-have-k3s-removed-from-upstream-kubernetes] for details).
+
 ## Hosts
 
 1. For production:
-   1. `k8s-prod-master-1`
-   2. `k8s-prod-worker-1`
-   2. `k8s-prod-worker-2`
-   2. `k8s-prod-worker-3`
+   1. `k3s-prod-master-1`
+   2. `k3s-prod-worker-1`
+   2. `k3s-prod-worker-2`
+   2. `k3s-prod-worker-3`
 1. For testing:. 
-   1. `k8s-test-master-1`
-   2. `k8s-test-worker-1`
-   3. `k8s-test-worker-2`
-   4. `k8s-test-worker-3`
-
-## References
-
-- https://github.com/justinas/nixos-ha-kubernetes
-- https://github.com/misumisumi/nixos-k8s-config
+   1. `k3s-test-master-1`
+   2. `k3s-test-worker-1`
+   3. `k3s-test-worker-2`
+   4. `k3s-test-worker-3`
 
+[k3s]: https://github.com/k3s-io/k3s/
+[what-have-k3s-removed-from-upstream-kubernetes]: https://github.com/k3s-io/k3s/?tab=readme-ov-file#what-have-you-removed-from-upstream-kubernetes