diff README @ 8:e0cd5ede76af

Better documentation.
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Thu, 19 May 2011 20:52:34 +0200
parents d5cfe54f11aa
children a637cde69f71
line wrap: on
line diff
--- a/README
+++ b/README
@@ -26,14 +26,8 @@ https://github.com/astro/node-xmpp
 Or if your distribution has these packaged (as in ArchLinux), simply
 install the packaged version.
 
-The config file is configuration.js, in the source directory, and the
-directory for the persistent storage of the avatars is defined in the
-variable config.directory.
-
-configuration.js should contain these two lines, matching the ones in
-your XMPP server:
- exports.jid = 'avatar.your.xmpp.server.tld';
- exports.password = 'the shared secret'
+The config file is configuration.js, in the source directory. All
+options should be enough documented; if not, contact me.
 
 When you have the dependances installed, you can simply run:
  % ./avatar.js