annotate README @ 2:1299e2d8497f

Clarify README.
author Sonny Piers <sonny.piers@gmail.com>
date Wed, 15 Jun 2011 06:24:09 +0200
parents 56b67e2b35b1
children fb9e6a945287
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
1 Dependencies:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
2 node-xmpp
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
3 Nodemailer
2
1299e2d8497f Clarify README.
Sonny Piers <sonny.piers@gmail.com>
parents: 1
diff changeset
4
1
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
5 Optionnal dependency:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
6 node-ispdb (for easy SMTP setup account, it will find smtp settings for a given email address)
2
1299e2d8497f Clarify README.
Sonny Piers <sonny.piers@gmail.com>
parents: 1
diff changeset
7
1299e2d8497f Clarify README.
Sonny Piers <sonny.piers@gmail.com>
parents: 1
diff changeset
8 Configuration:
1
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
9 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;
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
10
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
11 How it works:
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
12 For example you wan't to send hello to john@email.com from the gateway mailer.xmpp.tld
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
13 Send a message to john%email.com@mailer.xmpp.tld
56b67e2b35b1 Adds README.
Sonny Piers <sonny.piers@gmail.com>
parents:
diff changeset
14
2
1299e2d8497f Clarify README.
Sonny Piers <sonny.piers@gmail.com>
parents: 1
diff changeset
15 Licence:
1299e2d8497f Clarify README.
Sonny Piers <sonny.piers@gmail.com>
parents: 1
diff changeset
16 MIT