annotate README @ 427:f6f4f99f1a1b

doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
author Goffi <goffi@goffi.org>
date Fri, 09 Oct 2020 18:22:45 +0200
parents d58599801c23
children 074037832daf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
405
c56a728412f1 file organisation + setup refactoring:
Goffi <goffi@goffi.org>
parents: 404
diff changeset
1 SàT PubSub
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
2
384
aa3a464df605 dates update
Goffi <goffi@goffi.org>
parents: 371
diff changeset
3 Copyright (c) 2012-2019 Jérôme Poisson
311
a776544d84e5 copyright update
Goffi <goffi@goffi.org>
parents: 305
diff changeset
4 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
5 Copyright (c) 2003-2011 Ralph Meijer
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
6
405
c56a728412f1 file organisation + setup refactoring:
Goffi <goffi@goffi.org>
parents: 404
diff changeset
7 SàT PubSub is a PubSub/PEP component for XMPP
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
8
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
9
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
10 ** LICENSE **
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
11
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
12 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
13 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
14 the Free Software Foundation, either version 3 of the License, or
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
15 (at your option) any later version.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
16
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
17 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
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
20 GNU Affero General Public License for more details.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
21
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
22 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
23 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
24
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
25
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
26 ** ABOUT **
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
27
407
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
28 SàT PubSub is a XMPP PubSub/PEP component (XEP-0060) It's based on Ralph
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
29 Meijer's Idavoll, and provides special features necessary for the « Salut à
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
30 Toi » project (https://salut-a-toi.org), but it can also be used for any other
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
31 XMPP project. The use of a standard external component allow to use this
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
32 features with most XMPP servers. One of the main addition is fine access
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
33 tuning for PubSub, which allow the publication of items for only some groups,
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
34 even if the entire node is open. The protocol is explained on
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
35 https://www.goffi.org/post/2012/06/24/Fine-access-tuning-for-PubSub for the
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
36 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
37
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
38
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
39 ** INSTALLATION **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
40
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents: 386
diff changeset
41 Please check doc/ directory
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
42
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
43
407
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
44 ** CREDITS **
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
45
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
46 The base project (Idavoll) was made by Ralph Meijer and can be found on
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
47 http://idavoll.ik.nu/.
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
48 The main authors of SàT Pubsub (beside original work) are Jérôme Poisson and
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
49 Adrien Cossa.
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
50
407
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
51 Idavoll has also received a contribution which have been inherited in SàT
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
52 Pubsub from Christopher Zorn.
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
53
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
54 SàT Pubsub has received contributions from:
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
55
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
56 - Arnaud Joset
d58599801c23 README: updated "CREDITS" section
Goffi <goffi@goffi.org>
parents: 405
diff changeset
57 - W. Martin Borgert
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
58
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
59
371
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
60 ** CONTRIBUTIONS **
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
61
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
62 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
63
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
64 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
65 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
66
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
67 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
68
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
69
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
70 ** CONTACT **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
71
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
72 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
73 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
74
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
75 XMPP MUC: sat@chat.jabberfr.org