Mercurial > eldonilo > avatar
comparison README @ 0:d5cfe54f11aa
Initial commit.
| author | Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> |
|---|---|
| date | Wed, 02 Mar 2011 17:33:28 +0100 |
| parents | |
| children | e0cd5ede76af |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:d5cfe54f11aa |
|---|---|
| 1 | |
| 2 | |
| 3 ======================================== | |
| 4 | |
| 5 JavaScript XMPP Avatar Retriever | |
| 6 | |
| 7 ======================================== | |
| 8 | |
| 9 | |
| 10 ======================= | |
| 11 Install | |
| 12 ======================= | |
| 13 The source code is available here: | |
| 14 http://linkmauve.fr/avatar/source/code | |
| 15 | |
| 16 You can try it by appending a JID after <http://linkmauve.fr/avatar/>, | |
| 17 like: | |
| 18 http://linkmauve.fr/avatar/linkmauve@linkmauve.fr | |
| 19 | |
| 20 This program requiers the node.js framework, and either the xmpp.js | |
| 21 library or node-xmpp. You can find these software here: | |
| 22 http://nodejs.org/ | |
| 23 http://xmppjs.prosody.im/ | |
| 24 https://github.com/astro/node-xmpp | |
| 25 | |
| 26 Or if your distribution has these packaged (as in ArchLinux), simply | |
| 27 install the packaged version. | |
| 28 | |
| 29 The config file is configuration.js, in the source directory, and the | |
| 30 directory for the persistent storage of the avatars is defined in the | |
| 31 variable config.directory. | |
| 32 | |
| 33 configuration.js should contain these two lines, matching the ones in | |
| 34 your XMPP server: | |
| 35 exports.jid = 'avatar.your.xmpp.server.tld'; | |
| 36 exports.password = 'the shared secret' | |
| 37 | |
| 38 When you have the dependances installed, you can simply run: | |
| 39 % ./avatar.js | |
| 40 to launch the component. | |
| 41 | |
| 42 There is no install procedure for now. | |
| 43 | |
| 44 Please DO report any bug you encounter and ask for any | |
| 45 feature you want. | |
| 46 | |
| 47 ======================= | |
| 48 Authors | |
| 49 ======================= | |
| 50 Emmanuel Gil Peyrot (Link Mauve) <linkmauve@linkmauve.fr> | |
| 51 | |
| 52 ======================= | |
| 53 Contact/support | |
| 54 ======================= | |
| 55 XMPP or SMTP: linkmauve@linkmauve.fr | |
| 56 | |
| 57 ======================= | |
| 58 License | |
| 59 ======================= | |
| 60 This is Free Software. | |
| 61 (learn more: http://www.gnu.org/philosophy/free-sw.html) | |
| 62 | |
| 63 This is released under the Gnu AGPLv3 license | |
| 64 Please read the COPYING file for details |