init

1 files changed, 20 insertions, 0 deletions

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`)