aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f39d5a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# SecKey
+
+This project is intended to be used when your system
+uses a usb-drive to decrypt your system's root drive.
+
+If you want that if you plug out the stick your system shuts down
+you are at the right place here.
+
+## Install
+
+Edit the `config.mk` and insert the UUID of your usb-drive.
+Then type:
+
+```sh
+sudo make install
+```