doc(README): added Readme

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..42228e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# mail-smtp   [![Build Status](https://travis-ci.org/1aim/mail_smtp.svg?branch=master)](https://travis-ci.org/1aim/mail_smtp)
+
+**[internal/mail-api] combines mail-types with new-tokio-smtp**
+
+---
+
+Mainly provides a `send_mails` method, which given a `ConnectionConfig` and
+a iterable source of `MailRequest`'s (e.g. `Vec<MailRequest>`) sends all mails
+to the server specified in the `ConnectionConfig`. This includes setting up
+the connection running a auth command, encoding all mails, sending each mail
+and closing the connection afterwards.
+
+Take a look at the [`mail-api` crate](https://github.com/1aim/mail-api) for more details.
+
+Documentation can be [viewed on docs.rs](https://docs.rs/mail-smtp).
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.