Skip to content

Commit

Permalink
chg: [doc] rssdir is now the modern world
Browse files Browse the repository at this point in the history
  • Loading branch information
adulau committed Feb 11, 2024
1 parent a8e68ea commit 68eadef
Showing 1 changed file with 23 additions and 7 deletions.
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,29 @@ Options:
output format (text, phtml, markdown), default text
~~~

## rssdir

[rssdir.py](https://github.com/adulau/rss-tools/blob/master/bin/rssdir.py) is a simple and straightforward script designed to convert any directory on the filesystem into an RSS feed.

~~~shell
rssdir.py --prefix https://www.foo.be/cours/ . >rss.xml
~~~

~~~shell
Usage: rssdir.py [options] directory

Options:
-h, --help show this help message and exit
-p PREFIX, --prefix=PREFIX
http prefix to be used for each entry, default none
-t TITLE, --title=TITLE
set a title to the rss feed, default using prefix
-l LINK, --link=LINK http link set, default is prefix and none if prefix
not set
-m MAXITEM, --maxitem=MAXITEM
maximum item to list in the feed, default 32
~~~

## Scripts which need to be converted an are there for historical purpose

rsscount.py
Expand All @@ -52,13 +75,6 @@ rsscount.py is a simple script to count how many items are in a RSS feed per day

rsscount.py "<rss_url>" | sort

rssdir.py
---------

rssdir is a simply-and-dirty script to rssify any directory on the filesystem.

rssdir.py --prefix http://www.foo.be/cours/ . >rss.xml

rssinternetdraft.py
-------------------

Expand Down

0 comments on commit 68eadef

Please sign in to comment.