From: Scott Worley <scottworley@scottworley.com>
Date: Sat, 20 May 2023 05:05:32 +0000 (-0700)
Subject: README
X-Git-Url: http://git.scottworley.com/nix-profile-gc/commitdiff_plain/ee19b67b1a3179f92c06399a2311eb217b651172?hp=0c0420e86ec3391788a3b37022447bfd00f66443

README
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..21bb117
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Nix Profile GC
+
+Clean up old profiles more carefully than `nix-collect-garbage --delete-older-than`
+
+This module removes most old profiles, but makes sure to keep around the last few profiles that
+served this machine well -- profiles this machine ran on for a (configurable) time -- even if
+they're old.
+
+This is a NixOS Module rather than a stand-alone tool because it determines which extra profiles
+need preserving by periodically logging the currently-active profiles.
+
+See also: [Announcement](https://scottworley.com/blog/2023-05-19-nix-profile-gc.html)