diff --git a/README.md b/README.md index 98f467f..9e71942 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,23 @@ `org2newsboat` parses an [elfeed-org](https://github.com/remyhonig/elfeed-org) RSS file and writes a `urls` file readable by Newsboat (Newsbeuter's successor). It exports the URL, tags and link description as a comment if it exists. -# Installation +## Installation -`make install` to compile the binary and copy it in `~/.local/bin` +`make install` to compile the `org2newsboat` binary and copy it in `~/.local/bin` + +## Input Example +Example : RSS links with tags, commented headings, link description +``` +* RSS Subscriptions :elfeed: +... +** http://radiofrance-podcast.net/podcast09/rss_18081.xml :music: +** COMMENT https://thequietus.com/feed :music: +** [[https://www.youtube.com/channel/UCm9K6rby98W8JigLoZOh6FQ][LockPickingLawyer]] :sec: +``` + +## Output Example +The link description is kept as a comment, org headings marked as `COMMENT` are excluded from the generated feed list, tags are processed to work with Newsboat +``` +http://radiofrance-podcast.net/podcast09/rss_18081.xml music +https://www.youtube.com/channel/UCm9K6rby98W8JigLoZOh6FQ sec # LockPickingLawyer +```