sch/Rivista
2
1
Fork 1
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Improve wording

Browse source
This commit is contained in:
sch 2024-07-10 05:10:55 +02:00
parent d0ded117e2
commit af7f31e19b
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -15,14 +15,14 @@ This software was inspired from Tigase and was motivated by Movim.
## Motivation ## Motivation
PubSubToAtom is a syndication project which makes journals and publications that are hosted on XMPP PubSub nodes, available PubSub To Atom is a syndication project which makes journals and publications that are hosted on XMPP PubSub nodes, available
from HTTP to both, XML news readers and even HTML browsers. from HTTP to both, XML news readers and even HTML browsers.
This means that instead of hosting a journal or publication site in the old fashion (i.e. HTML documents hosted on an HTTP server), one only has to have an HTTP server to operate PubSubToAtom, and the rest of the content is delivered from an XMPP server (i.e. PubSub nodes). This means that instead of hosting a journal or publication site in the old fashion (i.e. HTML documents hosted on an HTTP server), one only has to have an HTTP server to operate PubSub To Atom, and the rest of the content is delivered from an XMPP server (i.e. PubSub nodes).
The project also showcases the non-necessity of HTML, as it automatically generates valid XHTML pages by XSLT stylesheets from client-side. The project also showcases the non-necessity of HTML, as it automatically generates valid XHTML pages by HTML browsers (client-side) from XSLT stylesheets.
Because PubSubToAtom reads XMPP PubSub nodes, it is possible to view a complete set of node items, and even a single node item, which means, that a considered and carefully earnest use of PubSubToAtom would save bandwidth and system overhead, which includes CPU, I/O and RAM usage. Because PubSub To Atom reads XMPP PubSub nodes, it is possible to view a complete set of node items, and even a single node item, which means, that a considered and carefully earnest use of PubSub To Atom would save bandwidth and system overhead, which includes CPU, I/O and RAM usage.
## Requirements ## Requirements
@ -44,8 +44,7 @@ Because PubSubToAtom reads XMPP PubSub nodes, it is possible to view a complete
### Download ### Download
Extract the source package to a directory that you have permission to run Extract the source package to a directory that you have permission to run software.
software.
```shell ```shell
$ git clone https://git.xmpp-it.net/sch/PubSubToAtom $ git clone https://git.xmpp-it.net/sch/PubSubToAtom
@ -58,7 +57,7 @@ Add account credentials to file `configuration.toml`.
### Start ### Start
Execute PubSubToAtom with one of the following commands: Execute PubSub To Atom with one of the following commands:
```shell ```shell
$ python -m uvicorn pubsub_to_atom:app --reload $ python -m uvicorn pubsub_to_atom:app --reload
@ -73,9 +72,9 @@ It is possible to view a complete node and even a single item, which means, that
### Viewing PubSub ### Viewing PubSub
Suppose you have the following nodes and items. Suppose you have the following PubSub nodes and items.
|PubSub |Node |Item | |Jabber ID |Node |Item |
|--- |--- |--- | |--- |--- |--- |
|blog.jmp.chat |urn:xmpp:microblog:0|launch-2023 | |blog.jmp.chat |urn:xmpp:microblog:0|launch-2023 |
|edhelas%40movim.eu|urn:xmpp:microblog:0|working-on-launching-the-movim-network-qPBzwc | |edhelas%40movim.eu|urn:xmpp:microblog:0|working-on-launching-the-movim-network-qPBzwc |
@ -83,6 +82,7 @@ Suppose you have the following nodes and items.
|news.movim.eu |Phoronix | | |news.movim.eu |Phoronix | |
|pubsub.movim.eu |berlin-xmpp-meetup |7363a41d-1146-40b3-ac0f-8ee2559591a3 | |pubsub.movim.eu |berlin-xmpp-meetup |7363a41d-1146-40b3-ac0f-8ee2559591a3 |
|pubsub.movim.eu |berlin-xmpp-meetup |let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4| |pubsub.movim.eu |berlin-xmpp-meetup |let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4|
|pubsub%40sure.im |news | |
#### To view node items #### To view node items
@ -90,6 +90,7 @@ Suppose you have the following nodes and items.
http://127.0.0.1:8000/atom?pubsub=edhelas%40movim.eu&node=urn%3Axmpp%3Amicroblog%3A0 http://127.0.0.1:8000/atom?pubsub=edhelas%40movim.eu&node=urn%3Axmpp%3Amicroblog%3A0
http://127.0.0.1:8000/atom?pubsub=news.movim.eu&node=Phoronix http://127.0.0.1:8000/atom?pubsub=news.movim.eu&node=Phoronix
http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup
http://127.0.0.1:8000/atom?pubsub=pubsub%40sure.im&node=news
``` ```
#### To view a node item #### To view a node item
@ -124,7 +125,7 @@ Thank you to to Mr. Timothée Jaussoin ([edhelas](https://edhelas.movim.eu/)) wh
A special thank you to the gentlemen "d3x" and "cchianel" from IRC channel #python on irc.libera.chat for initial references concerning code, servers and FastAPI. A special thank you to the gentlemen "d3x" and "cchianel" from IRC channel #python on irc.libera.chat for initial references concerning code, servers and FastAPI.
And an important thank you to Mr. Simone Canaletti ([roughnecks](https://blog.woodpeckersnest.space/)) for testing and deploying PubSubToAtom into production. And an important thank you to Mr. Simone Canaletti ([roughnecks](https://blog.woodpeckersnest.space/)) for testing and deploying PubSub To Atom into production.
## Similar Projects ## Similar Projects