summaryrefslogtreecommitdiffstats
path: root/autocrypt/README.md
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-02-06 17:46:56 +0100
committerJustus Winter <justus@sequoia-pgp.org>2020-02-06 18:01:33 +0100
commit6953b4f9902f5f524e92a15518d0132fb662704a (patch)
treea02b4e656196a674146709ad42f32f4b295dcac3 /autocrypt/README.md
parent2bd001a81fa53e4f3cbc972f6354c8e3e510d1c7 (diff)
autocrypt: New crate.
- Move the autocrypt-related functionality to a new crate. - Fixes #424.
Diffstat (limited to 'autocrypt/README.md')
-rw-r--r--autocrypt/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/autocrypt/README.md b/autocrypt/README.md
new file mode 100644
index 00000000..3a502ea3
--- /dev/null
+++ b/autocrypt/README.md
@@ -0,0 +1,12 @@
+# sequoia-autocrypt
+
+This module deals with Autocrypt encoded data (see the [Autocrypt
+Spec]).
+
+ [Autocrypt Spec]: https://autocrypt.org/level1.html#openpgp-based-key-data
+
+# Scope
+
+This implements low-level functionality like encoding and decoding of
+Autocrypt headers and setup messages. Note: Autocrypt is more than
+just headers; it requires tight integration with the MUA.