sfeed

commit e11d6d36d576683ec63dda6495bfaf9faaa2ec87
parent 96a333b11544e4120a25633d5e23e7ff5789a91e
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date:   Wed,  9 Apr 2014 00:33:52 +0200

update docs

Signed-off-by: Hiltjo Posthuma <hiltjo@codemadness.org>

Diffstat:
M
CHANGELOG
 | 
2
+-
M
README
 | 
15
++++++++++++---
M
TODO
 | 
2
++

3 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
@@ -6,7 +6,7 @@ Features:
 
 	* Feeds are now by default updated in parallel for an increase in performance.
 	* Auto-detect XML character set encoding (sfeed_xmlenc).
-	* Auto-detect RSS/Atom feeds from web-pages (sfeed_web).
+	* Find RSS/Atom feeds from web-pages (sfeed_web).
 	* Added sfeed_frames, a formatting program to output feeds as a HTML file with
 	  frames. It's optimized to look good in older browsers that don't necesarily
 	  support CSS or modern HTML, like links. See the man page for more details.
diff --git a/README b/README
@@ -29,7 +29,7 @@ Platforms tested
 - Linux
 - OpenBSD
 - Windows (cygwin, mingw).
-- DOS.
+- DOS
 
 
 Files
@@ -44,8 +44,8 @@ sfeed_html        - Format feeds file (TSV) from sfeed_update to HTML.
 sfeed_frames      - Format feeds as a HTML file with frames.
 sfeed_opml_import - Generate a sfeedrc config file based on an opml file.
 sfeed_opml_export - Generate an opml file based on a sfeedrc config file.
-sfeed_xmlenc      - Detect character set encoding from XML stream.
-sfeed_web         - Detect url to RSS/Atom feed from a webpage.
+sfeed_xmlenc      - Detect character-set encoding from XML stream.
+sfeed_web         - Find urls to RSS/Atom feed from a webpage.
 sfeedrc.example   - Example config file.
 style.css         - Example stylesheet to use with sfeed_html or sfeed_frames.
 
@@ -112,6 +112,15 @@ mk install
 Usage
 -----
 
+Find RSS/Atom feed urls from a webpage:
+
+$ url="codemadness.org"; wget -L -q -O - "$url" | sfeed_web "$url"
+
+output:
+	application/rss+xml http://codemadness.org/blog/rss.xml
+	application/atom+xml http://codemadness.org/blog/atom.xml
+
+
 To update feeds and format the feeds file (configfile argument is optional):
 
 sfeed_update "configfile"
diff --git a/TODO b/TODO
@@ -7,6 +7,8 @@
 	[x] html content isnt unescaped (see ContentType (plain or html)), (sfeed_frames and sfeed_html).
 	[ ] in links browsers: items are centered in the table for some reason.
 
+[ ] compile and test on plan9
+
 [x] add plan9 mkfile?
 
 [ ] feeds file: empty tab (encoding cant be detected?)