view README @ 25:ba0edeb9ba05 default tip

Put the repository more in evidence, add an in-memory s2s blacklist and fix a few minor stuff.
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sun, 02 Dec 2012 13:19:54 +0100
parents 1cb2279e3f30
children
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 requires 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

For example, if you are using npm, you can do:
npm install node-xmpp
npm install node-stringprep (it depends of libicu-dev on debian)
npm install ltx

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 dependencies 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