# HG changeset patch
# User Sonny Piers <sonny.piers@gmail.com>
# Date 1308111632 -7200
# Node ID 56b67e2b35b1c5e3f427143e9b4b3ca08f76caca
# Parent  e459f344d8bdcca7085b9bcb2125a2c5988d731f
Adds README.

diff --git a/README b/README
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+Notes:
+
+This is experimental for the moment. Currently working on making it better.
+I would love to get feedbacks.
+
+Dependencies:
+	node-xmpp
+	Nodemailer
+Optionnal dependency:
+	node-ispdb (for easy SMTP setup account, it will find smtp settings for a given email address)
+	
+configuration.js:
+config.SMTP are settings used if the XMPP user haven't registered to the gateway you can disable this feature by setting config.defaultSMTP to false;
+
+How it works:
+For example you wan't to send hello to john@email.com from the gateway mailer.xmpp.tld
+Send a message to john%email.com@mailer.xmpp.tld
+
+Licence MIT.