diff README @ 264:86e767dc6abb

packaging for release
author souliane <souliane@mailoo.org>
date Sat, 22 Feb 2014 06:10:24 +0100
parents d55620ceafed
children 002c59dbc23f
line wrap: on
line diff
--- a/README	Fri Feb 21 16:10:11 2014 +0100
+++ b/README	Sat Feb 22 06:10:24 2014 +0100
@@ -1,50 +1,52 @@
-Sat PubSub component
+SàT PubSub component v0.1.0
 This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer
 
+Copyright (c) 2014 Adrien Cossa
+Copyright (c) 2012, 2013, 2014 Jérôme Poisson
 Copyright (c) 2003-2011 Ralph Meijer
-Copyright (c) 2012, 2013 Jérôme Poisson
 
-** Below is the original README from Idavoll **
+Sàt PubSub is a PubSub component service for XMPP
+
+
 
 
-What is this?
-================
+** LICENSE **
 
-Idavoll is a Jabber publish-subscribe service component, as defined in
-JEP-0060, aiming to be fully compliant and mostly complete. The goal is to
-build a generic pubsub service, but of which parts can be reused for building
-custom pubsub services for specific applications.
+Sàt PubSub is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-Current Status
-==============
-
-There are two different backends: one using PostgreSQL for storage, and one
-just keeping everything in memory.
+Sàt PubSub is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
 
-In Idavoll the mimimal requirements of JEP-0060 version 1.11 are implemented
-plus a number of optional features, as returned by Service Discovery.
+You should have received a copy of the GNU Affero General Public License
+along with Sàt PubSub.  If not, see <http://www.gnu.org/licenses/>.
 
-Installing
-==========
+
+** ABOUT **
 
-Instructions for installing, configuring and running this software are in
-INSTALL. Also refer to UPGRADING for instruction on upgrading from older
-versions of Idavoll.
+SàT PubSub is a XMPP PubSub service component (XEP-0060)
+It's based on Ralph Meijer's Idavoll, but provide special features necessary for the « Salut à Toi » project ( http://sat.goffi.org ), but it can also be used for any other XMPP project.
+The use of a standard external component allow to use this features with most XMPP servers.
+One of the main addition is fine access tuning for PubSub, which allow the publication of items for only some groups, even if the entire node is open. The protocol is explained on http://www.goffi.org/post/2012/06/24/Fine-access-tuning-for-PubSub for the moment, and a protoxep should be proposed to the XSF in the future...
 
-Copyright
-=========
+
+** INSTALLATION **
 
-All of the code in this distribution is Copyright (c) 2003-2011 Ralph Meijer.
+Instructions for installation are the same as for Idavoll, so follow what is written in INSTALL and UPGRADING files.
+
 
-Idavoll is made available under the MIT license. The included LICENSE file
-describes this in detail.
+** CREDIT **
 
-Contact
-=======
+The base project (Idavoll) was made by Ralph Meijer and can be found on http://idavoll.ik.nu/
+
 
-Questions, comments or suggestions are welcome! There is a mailing list for
-Jabber related Twisted development at mailto:twisted-jabber@ik.nu. The list's
-info page lives here: https://mailman.ik.nu/mailman/listinfo/twisted-jabber.
+** CONTACT **
 
-Ralph Meijer
-<xmpp:ralphm@ik.nu>
+Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
+Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid)
+
+XMPP MUC: sat@chat.jabberfr.org