From ab5edd3b2219ec267348baed9647694e6f2ede3f Mon Sep 17 00:00:00 2001
From: Josh Rahm <joshuarahm@gmail.com>
Date: Fri, 24 Feb 2023 17:02:09 -0700
Subject: Add disable documentation.

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 53e3638..66c0ddd 100644
--- a/README.md
+++ b/README.md
@@ -42,3 +42,10 @@ $ ssh keyper@keyserver > /tmp/key
 $ sudo luksAddKey /dev/<disk> /tmp/key
 $ shred /tmp/key
 ```
+
+## Disabling Keyper
+
+Keyper can be temporarily disabled by `touch`-ing a file. This file defaults to
+`keyper-disabled` (in keyper's HOME directory), but can be overriden to any file
+by setting the environment `KEYPER_DISABLE_FILE`. When this file exists, keyper
+will exit with an error.
-- 
cgit