aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2014-10-07 12:58:01 -0300
committerSilvio Rhatto <rhatto@riseup.net>2014-10-07 12:58:01 -0300
commit5f8612c468b55aacf0233afc03ca9194aadee6e4 (patch)
tree58d8bc37fd76194e29b18ee505ac859da9c6410c /README.md
downloadfeeds-5f8612c468b55aacf0233afc03ca9194aadee6e4.tar.gz
feeds-5f8612c468b55aacf0233afc03ca9194aadee6e4.tar.bz2
Initial import
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..526560b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+Feeds in OPML format
+====================
+
+Build your own, cheap and valuable newspaper!
+
+This repository tries to solve the information metaproblem about where to
+get information? Not any information, but meaningful, i.e, which helps us
+act and make us think. Where to reach for news?
+
+This collection of OPML files is sorted by topic. As any collection, it's
+contents were selected using some arbitrary criteria and hence might not
+be of universal acceptance.
+
+So feel free to propose different groupings, submit pull requests or even
+forking this repository.
+
+How to use
+----------
+
+Simply import the OPML files into your feed readers. In newsbeuter, you
+can simply run the following command for each OPML file:
+
+ newsbeuter -i /path/to/feeds/topic.opml
+
+See http://newsbeuter.org/doc/newsbeuter.html#_migrating_from_other_rss_feed_readers
+for more information.
+
+Some feed readers even support to read directly from the OPML files. In newsbeuter,
+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
+for more information.
+
+If you're crazy enough, you can even point to the latest OPML version which
+should be available through the canonical URL:
+
+ opml-url "https://git.sarava.org/?p=feeds.git;a=blob_plain;f=topic.opml;hb=HEAD"
+
+How to make your own
+--------------------
+
+Copy `sample.opml` to a new file and edit to include your own set of feeds!