aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2026-01-02 18:05:12 -0300
committerSilvio Rhatto <rhatto@riseup.net>2026-01-02 18:05:12 -0300
commitf0b078009896bdc177bf0a147ceccdd66671ab43 (patch)
treeaae3506e7a24aaa184825f6fed1cd1336e86edc1
parent4da589c42b4ee24157a271b09f1d0e06fddb7d71 (diff)
downloadfeeds-f0b078009896bdc177bf0a147ceccdd66671ab43.tar.gz
feeds-f0b078009896bdc177bf0a147ceccdd66671ab43.tar.bz2
Fix: README update
-rw-r--r--ChangeLog.md1
-rw-r--r--README.md12
-rw-r--r--TODO.md4
3 files changed, 8 insertions, 9 deletions
diff --git a/ChangeLog.md b/ChangeLog.md
index 5b76f35..0e6f521 100644
--- a/ChangeLog.md
+++ b/ChangeLog.md
@@ -7,3 +7,4 @@
* [x] Project restructuring:
* [x] Adds ChangeLog and TODO files.
* [x] Move OPML files to a subfolder.
+* [x] Switch instructions from `newsbeuter` to `newsboat`.
diff --git a/README.md b/README.md
index 5355bf8..8df16e9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# Rhatto's OPML Hub
+A cartography of the internet.
+
Feeds in OPML format to help build your own, cheap but valuable newspaper!
## Intro
@@ -32,21 +34,21 @@ uncontextualized information!
## How to use
-Simply import the OPML files into your feed readers. In newsbeuter, you
+Simply import the OPML files into your feed readers. In newsboat, you
can simply run the following command for each OPML file:
- newsbeuter -i /path/to/feeds/topic.opml
+ newsboat -i /path/to/feeds/topic.opml
-See http://newsbeuter.org/doc/newsbeuter.html#_migrating_from_other_rss_feed_readers
+See http://newsboat.org/doc/newsboat.html#_migrating_from_other_rss_feed_readers
for more information.
-Some feed readers even support to read directly from the OPML files. In newsbeuter,
+Some feed readers even support to read directly from the OPML files. In newsboat,
this is achieved with just two lines in the configuration:
urls-source "opml"
opml-url "file:///path/to/feeds/topic1.opml" "file:///path/to/feeds/topic2.opml"
-See http://newsbeuter.org/doc/newsbeuter.html#_opml_online_subscription_mode
+See http://newsboat.org/doc/newsboat.html#_opml_online_subscription_mode
for more information.
You can even point to the latest OPML version which should be available through
diff --git a/TODO.md b/TODO.md
index dffc135..2512e3a 100644
--- a/TODO.md
+++ b/TODO.md
@@ -21,7 +21,3 @@
* [ ] Open feature request upstream to allow for recursive
OPML lookups, so OPML files can be listed inside
other OPML files.
-
-## Documentation
-
-* [ ] Switch instructions from `newsbeuter` to `newsboat`.