1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9dd08c6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# ghpatch
+
+A simple server that listens to pull requests from GitHub Webhooks and
+converts them to emailed patches.
+
+## Warning
+
+```go
+/*
+NOTE: Do not use this in production yet as GitHub secrets validation,
+      replay attack prevention, quite a lot of error checking, etc., are not
+      implemented yet.
+*/
+```
+
+## Configuration
+
+Modify `main.go` to configure the program. (This will change once I'm a
+bit more comfortable with Go.)
+
+Run this behind a reverse proxy.
+
+## Copyright status
+
+Public domain, or CC0-1.0 as an alternative. A parent grant applies,
+check the LICENSE file for details.