From 09c2b6de63a6ff35348fcb2c2eb57b974f0a8a52 Mon Sep 17 00:00:00 2001
From: Kleidi Bujari <mail@4kb.net>
Date: Wed, 2 Apr 2025 21:59:20 -0400
Subject: automate project structure

---
 modules/xnet/README | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 modules/xnet/README

(limited to 'modules/xnet/README')

diff --git a/modules/xnet/README b/modules/xnet/README
new file mode 100644
index 0000000..ab1c28c
--- /dev/null
+++ b/modules/xnet/README
@@ -0,0 +1,18 @@
+xnet
+====
+
+Base configuration for any machines running a standard xnet
+configuration.
+
+Notable features:
+
+  - Root filesystem running in RAM
+  - Automated ZFS partitioning of disk
+  - Hardened SSH and web services
+
+Usage
+=====
+
+The entire module is exposed from the top-level flake as a nixosModule,
+but it changes too often to be considered stable. Options are made
+available when imported under the 'xnet' attribute set.
-- 
cgit v1.3.1