summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhilipp Korber <p.korber@1aim.com>2018-12-03 17:53:58 +0100
committerPhilipp Korber <p.korber@1aim.com>2018-12-03 17:53:58 +0100
commit7be694177c3f264fa552822cc6f937047d61616e (patch)
treef248bad7c078df8716dd68e0252b9fcd44e9505b
parent53f584899bab4c205d94c92fc242f6e05c6f9732 (diff)
doc(README) added minimal readme to repository
- each crate had a readme but the repo on itself does not
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3d361a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+
+# mail
+
+This repository contains the rust mail crates.
+
+They provides ways to represent, generate and
+send mails.
+
+The generation can be done with custom code or
+using a template library. Bindings for `handlebars`
+are included but binding other libraries isn't
+hard either.
+
+The sending is done over `SMTP` it is currently
+focused on sending the mails to a
+Message Submission Agent (MSA) through it could
+be used in other contexts, too.
+
+Currently there is no mail parsing implemented.
+
+The readme of the `mail` crate which acts as
+a facade exposing all this features can be
+fund under [`mail/README.md`](mail/README.md) \ No newline at end of file