annotate README @ 371:8bf2db9accf0

README: added contribution links
author Goffi <goffi@goffi.org>
date Wed, 27 Jun 2018 07:18:22 +0200
parents 618a92080812
children aa3a464df605
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
284
dfc47748d8d8 CHANGELOG update
Goffi <goffi@goffi.org>
parents: 283
diff changeset
1 SàT PubSub component v0.1.1
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
2 This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
3
368
618a92080812 date update
Goffi <goffi@goffi.org>
parents: 365
diff changeset
4 Copyright (c) 2012-2018 Jérôme Poisson
311
a776544d84e5 copyright update
Goffi <goffi@goffi.org>
parents: 305
diff changeset
5 Copyright (c) 2014-2016 Adrien Cossa
235
64f780413b82 fixed Ralph Meijer copyright years (last commit was in 2011, not in 2009)
Goffi <goffi@goffi.org>
parents: 233
diff changeset
6 Copyright (c) 2003-2011 Ralph Meijer
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
7
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
8 Sàt PubSub is a PubSub component service for XMPP
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
9
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
10
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
11
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
12
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
13 ** LICENSE **
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
14
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
15 Sàt PubSub is free software: you can redistribute it and/or modify
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
16 it under the terms of the GNU Affero General Public License as published by
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
17 the Free Software Foundation, either version 3 of the License, or
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
18 (at your option) any later version.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
19
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
20 Sàt PubSub is distributed in the hope that it will be useful,
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
23 GNU Affero General Public License for more details.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
24
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
25 You should have received a copy of the GNU Affero General Public License
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
26 along with Sàt PubSub. If not, see <http://www.gnu.org/licenses/>.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
27
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
28
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
29 ** ABOUT **
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
30
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
31 SàT PubSub is a XMPP PubSub service component (XEP-0060)
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
32 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.
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
33 The use of a standard external component allow to use this features with most XMPP servers.
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
34 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...
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
35
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
36
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
37 ** INSTALLATION **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
38
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
39 Instructions for installation are the same as for Idavoll, so follow what is written in INSTALL and UPGRADING files.
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
40
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
41
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
42 ** CREDIT **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
43
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
44 The base project (Idavoll) was made by Ralph Meijer and can be found on http://idavoll.ik.nu/
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
45
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
46
371
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
47 ** CONTRIBUTIONS **
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
48
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
49 Here are the URIs you can use to publish/retrieve tickets or merge requests:
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
50
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
51 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "SàT Pubsub" label)
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
52 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "SàT Pubsub" label)
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
53
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
54 Tickets and merge requests are handled by SàT itself using XMPP.
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
55
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
56
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
57 ** CONTACT **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
58
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
59 Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
60 Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid)
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
61
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
62 XMPP MUC: sat@chat.jabberfr.org