diff options
authorSjoerd Simons <>2012-09-10 10:01:15 +0200
committerSjoerd Simons <>2012-09-10 10:01:22 +0200
commit08134249e54d01824851a56251a6bfa72af6963b (patch)
parent1afdb3a4a90fdea5af1aaaa7ee3a63df0a9d711e (diff)
Add a basic README
1 files changed, 13 insertions, 1 deletions
diff --git a/README b/README
index 31c7878..b93d0be 100644
--- a/README
+++ b/README
@@ -1 +1,13 @@
-Telepathy phoenix echo bot & tester
+Telepathy Phoenix echo bot & tester
+Phoenix is a echo bot for the telepathy framework re-using the standard
+Telepathy infrastructure. Mission control is used for the account management,
+standard Telepathy clients are used for the echo implementation.
+To setup the echo bot, configure and enable the echo bot account in
+mission-control (using mc-tool for example). If passwords are requried, the
+authentication handler for Phoenix can only handle the X-TELEPATHY-PASSWORD
+mechanism and expects to find the password in a file called phoenix/auth under
+XDG_CONFIG_HOME (normally ~/.config). The format of this file is simply, one
+line for each account containing:
+ <account path suffix> <password>