From 2970073d5e42e4412c047cd2edee01e30968065f Mon Sep 17 00:00:00 2001
From: Ryan Yin <xiaoyin_c@qq.com>
Date: Sun, 30 Jul 2023 01:20:47 +0800
Subject: [PATCH] feat: add README for lib

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

diff --git a/lib/README.md b/lib/README.md
new file mode 100644
index 00000000..bb96e1b4
--- /dev/null
+++ b/lib/README.md
@@ -0,0 +1,7 @@
+# Library
+
+Some Helper functions for the project:
+
+1. `macosSystem`: A function to generate attribute set for macOS, used by `flake.nix` to reduce code duplication and make it easier to add new machines.
+2. `nixosSystem`: A function to generate attribute set for NixOS, used by `flake.nix` to reduce code duplication and make it easier to add new machines.
+