diff --git a/README.md b/README.md index acdaa09..55d9078 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # transWhat -for documentation look here: http://dev.0l.de/projects/transwhat/start +transWhat is a WhatsApp XMPP Gateway based on Spectrum2 + +## Dependencies + +* __Spectrum 2__ is a XMPP transport + Manual compile latest version from https://github.com/hanzz/libtransport +* __e4u__ is a simple emoji4unicode python wrapper library + Install with `pip install e4u` +* __Yowsup__ is a Implementation of the WhatsApp protocol in python + Use my patched version at https://github.com/stv0g/yowsup +* __Google Atom and GData__ Python wrappers + +## Contribute + +Pull requests, bug reports etc. are welcome. +Help us to provide a open implementation of the WhatsApp protocol. + +## Documentation + +A project wiki is available [here](http://dev.0l.de/projects/transwhat/start). +A mailinglist for discussion is available [here](http://lists.0l.de/listinfo/whatsapp). + +A writeup of this project is also availabe at my [blog](http://www.steffenvogel.de/2013/06/29/transwhat/).