diff README @ 0:9ee956af41e3

Initial commit
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sun, 27 Jun 2010 22:05:12 +0200
parents
children 023f767662d3
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,69 @@
+                      _
+    _____   _____   _/_\_   _____
+   |  _  \ /  ___/ /  ___| /  ___/
+   | |_| | | |___  | |     | |___
+   |  ___/ \___  \ | |  _  \___  \
+   | |      ___| | | |_| |  ___| |
+   |_|     /_____/ \_____/ /_____/
+
+Homepage: http://linkmauve.fr/dev/psgxs
+Forge page: http://codingteam.net/project/psgxs
+
+PSĜS is PubSub server written in JavaScript. Its goal is to be a
+full-featured server implementing the PubSub specification
+(<http://xmpp.org/extensions/xep-0060.html>).
+
+=======================
+        Install
+=======================
+PSĜS use node.js, the xmpp.js library and its dependance, node-xml. You
+can find these software here:
+http://nodejs.org/
+http://github.com/robrighter/node-xml
+http://xmppjs.prosody.im/
+
+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
+file for the persistent storage of the tree is <save.json>.
+
+When you have the dependances installed, you can simply run:
+ % ./psgxs
+to launch PSĜS.
+
+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 ChatRoom:     psgxs@conference.codingteam.net
+Report a bug:      http://codingteam.net/project/psgxs/bugs/add
+
+=======================
+        License
+=======================
+PSĜS is Free Software.
+(learn more: http://www.gnu.org/philosophy/free-sw.html)
+
+PSĜS is released under the Gnu AGPLv3 license
+Please read the COPYING file for details
+
+=======================
+        Thanks
+=======================
+= People =
+ Paul Sowden (<http://delete.me.uk/>) - ISO 8601 date functions
+
+======================
+       The code
+======================
+… is awful! :D