summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-16 17:13:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-16 17:13:42 +0000
commit119fcc3f6b480eb6791dfb79b6f9eae641705db0 (patch)
tree103ae60fcd710bfa9b07791630a4230ba4a6396d /README.md
parentInitial commit. (diff)
downloadgolang-github-containers-luksy-119fcc3f6b480eb6791dfb79b6f9eae641705db0.tar.xz
golang-github-containers-luksy-119fcc3f6b480eb6791dfb79b6f9eae641705db0.zip
Adding upstream version 0.0~git20231017.6a3592c+ds1.upstream/0.0_git20231017.6a3592c+ds1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2bf3a43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+luksy: offline encryption/decryption using LUKS formats [![Cirrus CI Status](https://img.shields.io/cirrus/github/containers/luksy/main)](https://cirrus-ci.com/github/containers/luksy/main)
+-
+luksy implements encryption and decryption using LUKSv1 and LUKSv2 formats.
+Think of it as a clunkier cousin of gzip/bzip2/xz that doesn't actually produce
+smaller output than input, but it encrypts, and that's nice.
+
+* The main goal is to be able to encrypt/decrypt when we don't have access to
+ the Linux device mapper. Duplicating functions of cryptsetup that it can
+ perform without accessing the Linux device mapper is not a priority.
+* If you can use cryptsetup instead, use cryptsetup instead.