add simple readme

1 files changed, 21 insertions, 0 deletions

diff --git a/Readme.org b/Readme.org
new file mode 100644
index 0000000..b997ea0
--- /dev/null
+++ b/Readme.org
@@ -0,0 +1,21 @@
+* age-encryption in web assembly
+
+** Compile
+Compile with:
+
+#+BEGIN_SRC
+wasm-pack build --target web
+#+END_SRC
+
+don't forget the ~--target web~, otherwise strange mimetype issues
+may arise in browsers.
+
+** What?
+Mostly an experiment how well this works. Public key crypto works fine,
+but for some reason decrypting files encrypted with a passphrase takes
+an inordinate amount of time, and browsers' mining-detectors tend to
+complain.
+
+The encryption used is the [[https://crates.io/crates/age][age rust crate]], which is a reimplementation
+of Filippo Valsorda's [[age-encryption.org][age encryption]]. The rust implementation is still
+marked as beta, so this probably shouldn't be used for anything important.