1 files changed, 18 insertions(+), 2 deletions(-)

R README => README.md

@@ 1,10 1,26 @@
 This is an XMPP to SMTP bridge. Very pre-release and not at all done.
 
-== Getting Help ==
+## Main Instance
+
+If you want to use this, you should probably use the instance at smtp.cheogram.com
+
+## Installing
+
+If you want to install this yourself, you may compile from source or grab binaries from CI: https://builds.sr.ht/~singpolyma/cheogram-smtp
+
+The `gateway` binary must run all the time as an XEP-0114 component.  Usage:
+
+    ./gateway component.hostname xmpp.server.hostname xep0114-port xep0114-secret /path/to/sendmail jid@of.incoming-email
+
+The `incoming-email` binary expects emails on STDIN and sends them over XMPP to the gateway.  Usage:
+
+    ./incoming-email jid@of.incoming-email password component.hostname recipient1@of.email ... < email
+
+## Getting Help
 
 If you have any questions about this library, or wish to report a bug, please send email to: dev@singpolyma.net
 
-== Contributing ==
+## Contributing
 
 If you have code or patches you wish to contribute, the maintainer's preferred mechanism is a git pull request.  Push your changes to a git repository somewhere, for example: