forked from sch/Slixfeed
Update README.md
This commit is contained in:
parent
634b0e3ce6
commit
be6e1e0622
1 changed files with 41 additions and 13 deletions
54
README.md
54
README.md
|
@ -1,7 +1,17 @@
|
||||||
# Slixfeed
|
# Slixfeed
|
||||||
Syndication bot for the XMPP communication network.
|
Syndication bot for the XMPP communication network.
|
||||||
|
|
||||||
## Getting started
|
Slixfeed aims to be an easy to use and fully-featured news aggregator bot for XMPP. It provides a convenient access to Blogs, Fediverse and News websites along with filtering functionality.
|
||||||
|
|
||||||
|
Slixfeed is primarily designed for XMPP (aka Jabber).
|
||||||
|
|
||||||
|
Visit https://xmpp.org/software/ for more information.
|
||||||
|
|
||||||
|
XMPP is the Extensible Messaging and Presence Protocol, a set of open technologies for instant messaging, presence, multi-party chat, voice and video calls, collaboration, lightweight middleware, content syndication, and generalized routing of XML data.
|
||||||
|
|
||||||
|
Visit https://xmpp.org/about/ for more information on the XMPP protocol.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
```
|
```
|
||||||
$ python slixfeed.py
|
$ python slixfeed.py
|
||||||
Username:
|
Username:
|
||||||
|
@ -12,36 +22,54 @@ Password:
|
||||||
- Start bot;
|
- Start bot;
|
||||||
- Add contact JID of Slixfeed to your roster;
|
- Add contact JID of Slixfeed to your roster;
|
||||||
- Open chat with Slixfeed;
|
- Open chat with Slixfeed;
|
||||||
- Add news source with `feed add URL`
|
- Add news source by sending a `<url>` (in groupchat, use `!<url>`).
|
||||||
|
|
||||||
|
### Feeds
|
||||||
|
Example feeds you can subscribe to.
|
||||||
```
|
```
|
||||||
feed add https://xmpp.org/feeds/all.atom.xml
|
https://xmpp.org/feeds/all.atom.xml
|
||||||
feed add https://redecentralize.org/podcast/feed.rss
|
https://takebackourtech.org/rss/
|
||||||
feed add http://hackerpublicradio.org/hpr_ogg_rss.php
|
https://redecentralize.org/podcast/feed.rss
|
||||||
|
http://hackerpublicradio.org/hpr_ogg_rss.php
|
||||||
|
https://www.blacklistednews.com/rss.php
|
||||||
|
https://theconsciousresistance.com/feed/
|
||||||
```
|
```
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
- Improve asynchronism hadling;
|
- Improve asynchronism hadling;
|
||||||
- Improve error handling;
|
- Improve logging and error handling;
|
||||||
- Add hash or urlencode;
|
|
||||||
- Add daemon interface;
|
- Add daemon interface;
|
||||||
- Add HTML support;
|
- Add HTML support (XHTML-IM);
|
||||||
- Add feed history tables of last week and last month.
|
- Add feed history tables of last week and last month.
|
||||||
|
|
||||||
## Authors and acknowledgment
|
## Authors
|
||||||
- Schimon Jehudah, Attorney at Law.
|
- Schimon Jehudah, Attorney at Law.
|
||||||
|
- [Laura](xmpp:lauranna@404.city) (Instructor, mentor and co-author).
|
||||||
|
|
||||||
|
## Acknowledgment
|
||||||
- [Alixander Court](https://alixandercourt.com/)
|
- [Alixander Court](https://alixandercourt.com/)
|
||||||
- [edhelas](https://github.com/edhelas/atomtopubsub)
|
- [edhelas](https://github.com/edhelas/atomtopubsub)
|
||||||
- habnabit_ from #python on irc.libera.chat (SQL security)
|
- habnabit_ from #python on irc.libera.chat (SQL security)
|
||||||
- [imattau](https://github.com/imattau/atomtopubsub) (Some code, mostly URL handling, was taken from imattau)
|
- [imattau](https://github.com/imattau/atomtopubsub) (Some code, mostly URL handling, was taken from imattau)
|
||||||
- [Laura](xmpp:lauranna@404.city) (Instructor, Mentor and Coauthor)
|
|
||||||
- [Link Mauve](https://linkmauve.fr/contact.xhtml)
|
- [Link Mauve](https://linkmauve.fr/contact.xhtml)
|
||||||
- magicfelix (async)
|
- magicfelix (async)
|
||||||
- Slixmpp participants who chose to remain anonymous or not to appear in this list.
|
- Slixmpp participants who chose to remain anonymous or not to appear in this list.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
AGPL-3.0 license
|
GPL-3.0 license
|
||||||
|
|
||||||
## Copyright
|
## Copyright
|
||||||
Schimon Jehudah 2022 - 2023
|
- Schimon Jehudah 2022 - 2023
|
||||||
Laura 2022 - 2023
|
- Laura 2022 - 2023
|
||||||
|
|
||||||
|
## Similar Projects
|
||||||
|
Please visit our friends who offer different approach to convey RSS to XMPP.
|
||||||
|
|
||||||
|
* [AtomToPubsub](https://github.com/imattau/atomtopubsub)
|
||||||
|
RSS feeds as XMPP Pubsub Nodes.
|
||||||
|
|
||||||
|
* [feed-to-muc](https://salsa.debian.org/mdosch/feed-to-muc)
|
||||||
|
An XMPP bot which posts to a MUC (groupchat) if there is an update in newsfeeds.
|
||||||
|
|
||||||
|
* [Morbot](https://codeberg.org/TheCoffeMaker/Morbot)
|
||||||
|
Morbo is a simple Slixmpp bot that will take new articles from listed RSS feeds and send them to assigned XMPP MUCs (groupchats).
|
||||||
|
|
Loading…
Reference in a new issue