From a711dab545e8b964914ac01ed06971a5a37ae22b Mon Sep 17 00:00:00 2001
From: seth <getchoo@tuta.io>
Date: Tue, 30 Apr 2024 04:07:12 -0400
Subject: init

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79b8259
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# flake-checks
+
+Simple, lightweight, and reusable Nix `flake check`s
+
+## Getting started
+
+```sh
+nix flake init --template github:getchoo/flake-checks # create a new flake with our template
+nix flake check --print-build-logs # and off to the races!
+```
+
+## Usage
+
+### `mkChecks :: { pkgs, root }`
+
+Returns an attribute set of our [supported checks](./checks)
+
+## Related projects
+
+- [git-hooks.nix](https://github.com/cachix/git-hooks.nix) (previously `pre-commit-hooks.nix`)
-- 
cgit v1.2.3