summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3082f4a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+`secsplit` is a simple wrapper around the
+`github.com/hashicorp/vault/shamir` package.
+
+`secsplit` lets you split a secret into several parts using [Shamir’s
+Secret Sharing][shamir] algorithm. `secsplit` also encodes those parts
+using Base64, and expects parts to be Base64-encoded when it reads them.
+
+[shamir]: https://en.wikipedia.org/wiki/Shamir's_Secret_Sharing