From 08134249e54d01824851a56251a6bfa72af6963b Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Mon, 10 Sep 2012 10:01:15 +0200 Subject: Add a basic README --- README | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) 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: + -- cgit v1.2.3