Add README.

* README.org: New file.

1 files changed, 32 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..ee3e16d
--- /dev/null
+++ b/README.org
@@ -0,0 +1,32 @@
+guile-email is a collection of email utilities implemented in pure
+guile. It supports parsing RFC5322 compliant email messages, and
+Multipurpose Internet Mail Extensions (MIME) compliant email messages
+as specified in RFC2045, RFC2046, RF2047 and RFC2049.
+
+* Features
+
+- Parse [[https://tools.ietf.org/html/rfc5322][RFC5322]] compliant email messages (currently does not support
+  [[https://tools.ietf.org/html/rfc5322#section-4][obsolete syntax]])
+- Parse MIME compliant email messages as specified in [[https://tools.ietf.org/html/rfc2045][RFC2045]],
+  [[https://tools.ietf.org/html/rfc2046][RFC2046]], [[https://tools.ietf.org/html/rfc2047][RFC2047]] and [[https://tools.ietf.org/html/rfc2049][RFC2049]]
+- Parse non-standard [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Mail-Headers.html][Emacs message mode parens style addresses]]
+- Encode and decode Quoted-Printable encoding, Base64 encoding and
+  Q-encoding
+
+* Future work
+
+- Support obsolete syntax as specified in RFC5322
+- Support MIME parameter value and encoded word extensions specified
+  in RFC2231
+- Support email generation
+
+* Contributing
+
+Feedback, suggestions, feature requests, bug reports and patches are
+all welcome. Please contact me by mail at [[mailto:arunisaac@systemreboot.net][arunisaac@systemreboot.net]].
+
+* License
+
+guile-email is free software released under the terms of the [[https://www.gnu.org/licenses/agpl.html][GNU
+Affero General Public License]], either version 3 of the License, or
+(at your option) any later version.