aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorMarvin Borner2023-06-19 22:38:59 +0200
committerMarvin Borner2023-06-19 22:38:59 +0200
commit1f7fb66baee1b1c655eafef51b7603c2773a6a84 (patch)
tree7cdcde0bcb924b4f081c20c049b56497c52659f0 /readme.md
parent01a943366a5eb813627c6131aeb952a98b2c46a7 (diff)
Added features
hehe
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..f15f163
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,12 @@
+# Vault
+
+> simple tool for storing files securely using luks encryption
+
+[![demo](https://asciinema.org/a/UU1AhA26xlIs9bWkUMmJAYTbm.svg)](https://asciinema.org/a/UU1AhA26xlIs9bWkUMmJAYTbm?autoplay=1)
+
+## Instructions
+
+- understand (and adapt) `vault.sh`
+- install `cryptsetup`, `e2fsprogs` and `qemu-img` (for resizing)
+- `sudo make install`
+- `vault help`