From 1d946c47fced8134d144a32da85a85f5183f71a9 Mon Sep 17 00:00:00 2001
From: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Tue, 18 Aug 2015 23:07:31 +0200
Subject: update README, add basic info at the top

hopefully this will make it easier to see the most important info first.
---
 README | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 51 insertions(+), 9 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 6a44414..90d450e 100644
--- a/README
+++ b/README
@@ -4,6 +4,56 @@ sfeed v0.9
 Simple RSS and Atom parser (and some format programs).
 
 
+Build and install
+-----------------
+
+Using make (respects $DESTDIR and $PREFIX):
+
+$ make
+# make install
+
+
+Usage
+-----
+
+Initial setup:
+
+	mkdir -p "$HOME/.sfeed/feeds"
+	cp sfeedrc.example "$HOME/.sfeed/sfeedrc"
+	cp style.css "$HOME/.sfeed/"
+
+Edit the feeds:
+
+	$EDITOR "$HOME/.sfeed/sfeedrc"
+
+or you you can use sfeed_opml_import to import your existing
+subscriptions from OPML format:
+
+	sfeed_opml_import < file.opml > "$HOME/sfeed/sfeedrc"
+
+Update feeds:
+
+	sfeed_update
+
+Format feeds, put this in some update script:
+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 "$HOME/.sfeed/frames"
+	cd "$HOME/.sfeed/frames" && sfeed_frames $HOME/.sfeed/feeds/*
+
+
+See the section "Usage and examples" below and the man-pages for more
+information how to use sfeed and the additional tools.
+
+
 Dependencies
 ------------
 
@@ -38,7 +88,7 @@ Files
 -----
 
 sfeed             - Binary (from sfeed.c); read XML RSS or Atom feed data from
-                    stdin. Write feed data in tab-separated format to stdout.
+                    stdin. Write feed data in TAB-separated format to stdout.
 sfeed_frames      - Format feed data (TSV) to HTML file(s) with frames.
 sfeed_html        - Format feed data (TSV) to HTML.
 sfeed_opml_export - Generate an OPML XML file from a sfeedrc config file.
@@ -111,14 +161,6 @@ CAVEATS:
 - HTML in titles is not supported on purpose.
 
 
-Build and install
------------------
-
-Using make (respects $DESTDIR and $PREFIX):
-
-make install
-
-
 Usage and examples
 ------------------
 
-- 
cgit v1.2.3