Slixfeed/README.md

46 lines
1.1 KiB
Markdown
Raw Normal View History

2022-06-21 15:39:08 +02:00
# Slixfeed
2022-06-21 16:19:01 +02:00
Syndication bot for the XMPP communication network.
2022-06-21 15:39:08 +02:00
## Getting started
```
2022-06-21 19:12:31 +02:00
$ python slixfeed.py
2022-06-21 16:19:01 +02:00
Username:
Password:
2022-06-21 15:39:08 +02:00
```
## Usage
2022-06-30 18:02:00 +02:00
- Start bot;
- Add contact JID of Slixfeed to your roster;
- Open chat with Slixfeed;
- Add news source with `feed add URL`
2022-06-21 15:39:08 +02:00
2022-06-21 16:19:01 +02:00
```
2022-06-30 18:02:00 +02:00
feed add https://xmpp.org/feeds/all.atom.xml
feed add https://redecentralize.org/podcast/feed.rss
feed add http://hackerpublicradio.org/hpr_ogg_rss.php
2022-06-21 16:19:01 +02:00
```
2022-06-21 15:39:08 +02:00
## Roadmap
2022-06-21 16:19:01 +02:00
- Improve asynchronism hadling;
2022-06-21 16:20:24 +02:00
- Improve error handling;
- Add hash or urlencode;
- Add daemon interface;
- Add HTML support;
2022-06-21 16:26:08 +02:00
- Add feed history tables of last week and last month.
2022-06-21 15:39:08 +02:00
## Authors and acknowledgment
2022-06-21 16:19:01 +02:00
- Schimon Jehudah, Attorney at Law.
2022-06-30 18:02:00 +02:00
- [Alixander Court](https://alixandercourt.com/)
2022-06-21 19:12:31 +02:00
- [edhelas](https://github.com/edhelas/atomtopubsub)
2022-06-26 19:32:11 +02:00
- [imattau](https://github.com/imattau/atomtopubsub) (Some code, mostly URL handling, was taken from imattau)
- [Laura](xmpp:lauranna@404.city)
2022-06-21 16:19:01 +02:00
- [Link Mauve](https://linkmauve.fr/contact.xhtml)
2022-06-26 19:32:11 +02:00
- magicfelix (async)
2022-06-21 16:19:01 +02:00
- Slixmpp participants who chose to remain anonymous or not to appear in this list.
2022-06-21 15:39:08 +02:00
## License
2022-06-21 16:19:01 +02:00
AGPL-3.0 license
2022-06-21 16:26:08 +02:00
## Copyright
Schimon Jehudah 2022