sfeed

commit cefc90357a8a2f20df7d15f29d2c4847330418ca
parent 29fa81e623c0e8787fcdc7a6109c3a24b562564a
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date:   Tue, 18 Aug 2015 22:36:08 +0200

update README

Diffstat:
M
README
 | 
40
++++++++++++++++++++++++----------------

1 file changed, 24 insertions(+), 16 deletions(-)
diff --git a/README b/README
@@ -127,44 +127,52 @@ Find RSS/Atom feed urls from a webpage:
 	url="codemadness.org"; curl -L -s "$url" | sfeed_web "$url"
 
 output:
-	application/rss+xml http://codemadness.org/blog/rss.xml
-	application/atom+xml http://codemadness.org/blog/atom.xml
+	http://codemadness.org/blog/rss.xml	application/rss+xml
+	http://codemadness.org/blog/atom.xml	application/atom+xml
 
 - - -
 
-To update feeds and format the feeds file (configfile argument is optional):
+Make sure your sfeedrc config file exists, see sfeedrc.example. To update
+your feeds (configfile argument is optional):
 
 	sfeed_update "configfile"
-	sfeed_html $HOME/.sfeed/feeds/* > $HOME/.sfeed/feeds.html
+
+Format the feeds files:
+
+	# Plain-text list.
 	sfeed_plain $HOME/.sfeed/feeds/* > $HOME/.sfeed/feeds.txt
+	# HTML view (no frames), copy style.css for a default style.
+	sfeed_html $HOME/.sfeed/feeds/* > $HOME/.sfeed/feeds.html
+	# HTML view with frames and content, copy style.css for a default style.
 	mkdir -p somedir && cd somedir && sfeed_frames $HOME/.sfeed/feeds/*
 
-Example script to view feeds with dmenu, opens selected url in $BROWSER:
-
-	#!/bin/sh
-	url=$(sfeed_plain $HOME/.sfeed/feeds/* | dmenu -l 35 -i |
-		sed 's@^.* \([a-zA-Z]*://\)\(.*\)$@\1\2@')
-	[ ! "$url" = "" ] && $BROWSER "$url"
+View in your browser:
 
+	$BROWSER "$HOME/.sfeed/feeds.html"
 
-or to view in your browser:
+View in your editor:
 
-	$BROWSER "$HOME/.sfeed/feeds.html"
+	$EDITOR "$HOME/.sfeed/feeds.txt"
 
+- - -
 
-or to view in your editor:
+Example script to view feeds with dmenu, opens selected url in $BROWSER:
 
-	$EDITOR "$HOME/.sfeed/feeds.txt"
+	#!/bin/sh
+	url=$(sfeed_plain $HOME/.sfeed/feeds/* | dmenu -l 35 -i |
+		sed 's@^.* \([a-zA-Z]*://\)\(.*\)$@\1\2@')
+	[ ! "$url" = "" ] && $BROWSER "$url"
 
+- - -
 
-Generate a sfeedrc config file from your exported list of feeds in opml
+Generate a sfeedrc config file from your exported list of feeds in OPML
 format:
 
 	sfeed_opml_import < opmlfile.xml > $HOME/.sfeed/sfeedrc
 
 - - -
 
-Export an opml file of your feeds from a sfeedrc config file (configfile
+Export an OPML file of your feeds from a sfeedrc config file (configfile
 argument is optional):
 
 	sfeed_opml_export configfile > myfeeds.opml