about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ca42f54
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+unpgpmime
+---------
+
+unpgpmime is a program that strips PGP/MIME information from an
+internet mail message.
+
+This is useful for programs that work with email but that don't
+support PGP/MIME, like git-am.
+
+Currently, only PGP/MIME encryption is supported (not unencrypted
+signatures).  Headers are copied from encrypted parts, providing
+compatibility with memoryhole[1].
+
+[1]: https://github.com/autocrypt/memoryhole
+
+The following packages must be available at runtime:
+
+* Ruby (2.6.0 or later)
+* mail (the Ruby library)
+* GnuPG
+
+Please report bugs and send patches to Alyssa Ross <hi@alyssa.is>.
+
+unpgpmime is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>. \ No newline at end of file