view README @ 10:a637cde69f71

Rename configuration.js to .example because it has to be modified by the user.
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Mon, 23 May 2011 12:18:38 +0200
parents e0cd5ede76af
children 1cb2279e3f30
line wrap: on
line source



	    ========================================

		JavaScript XMPP Avatar Retriever

	    ========================================


=======================
        Install
=======================
The source code is available here:
http://linkmauve.fr/avatar/source/code

You can try it by appending a JID after <http://linkmauve.fr/avatar/>,
like:
http://linkmauve.fr/avatar/linkmauve@linkmauve.fr

This program requiers the node.js framework, and either the xmpp.js
library or node-xmpp. You can find these software here:
http://nodejs.org/
http://xmppjs.prosody.im/
https://github.com/astro/node-xmpp

Or if your distribution has these packaged (as in ArchLinux), simply
install the packaged version.

An example of configuration file is provided in
configuration.js.example.  You only have to rename it as
configuration.js and modify it for your needs.  All options should be
enough documented; if not, contact me.

When you have the dependances installed, you can simply run:
 % ./avatar.js
to launch the component.

There is no install procedure for now.

Please DO report any bug you encounter and ask for any
feature you want.

=======================
        Authors
=======================
Emmanuel Gil Peyrot (Link Mauve) <linkmauve@linkmauve.fr>

=======================
    Contact/support
=======================
XMPP or SMTP: linkmauve@linkmauve.fr

=======================
        License
=======================
This is Free Software.
(learn more: http://www.gnu.org/philosophy/free-sw.html)

This is released under the Gnu AGPLv3 license
Please read the COPYING file for details