summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2015-08-23 21:29:49 +0200
committerHiltjo Posthuma <hiltjo@codemadness.org>2015-08-23 21:29:49 +0200
commit11666ed237972157a472a7a4774b72d0588d1c54 (patch)
treed10f9b8b44155f2a487a77349e2c2e900ff8746a
parentf28f56f160ecb7ddb3ed155474b41eaea8d2e2dc (diff)
improve README and CHANGELOG
-rw-r--r--CHANGELOG9
-rw-r--r--README10
2 files changed, 10 insertions, 9 deletions
diff --git a/CHANGELOG b/CHANGELOG
index 1a6d6bf..e70db0e 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -17,6 +17,7 @@ Features:
or stop parsing if it contains errors (which is good).
* Changed to mandoc for documentation.
+
Bug fixes:
----------
@@ -24,10 +25,10 @@ Bug fixes:
* Parsing datetime strings containing timezone suffix to UNIX timestamps
was wrong. UNIX timestamps are in UTC+0 time. For simplicity sake output
parsed datetime strings in a formatted manner without converting the
- time to the user selected timezone (YYYY-mm-dd HH:mm:ss TZ([-+]offset?).
-* Also when determining if an item is new (by comparing the UNIX
- timestamp) don't take into account timezones, because setenv(TZ,...) is
- just ugly and I don't use it.
+ time to the user selected timezone YYYY-mm-dd HH:MM:SS (UTC[+-][HHMM])|tz .
+* Also to determine if an item is new - by comparing the UNIX timestamp -
+ don't take into account timezones, because setenv(TZ,...) is just ugly and
+ I don't use it.
* Lots of small fixes for compatibility with RSS / Atom feeds.
* Many more improvements, I'll keep a more detailed list in the future.
diff --git a/README b/README
index 1c8ee72..d95810a 100644
--- a/README
+++ b/README
@@ -120,9 +120,9 @@ sfeedrc - Config file. This file is evaluated as a shellscript in
Files written at runtime by sfeed_update
----------------------------------------
-feeds - TAB-separated format containing all feeds. The sfeed_update script
- merges new items with this file.
-feeds.new - Temporary file used by sfeed_update to merge items.
+feedname - TAB-separated format containing all items per feed. The
+ sfeed_update script merges new items with this file.
+feedname.new - Temporary file used by sfeed_update to merge items.
TAB-separated format fields
@@ -131,8 +131,7 @@ TAB-separated format fields
The items are saved in a TSV-like format.
The fields: title, id, author are not allowed to have newlines and TABs. All
-whitespace is replaced by a single space character. Control characters are
-removed.
+whitespace is replaced by a space character. Control characters are removed.
The content field can contain newlines and is escaped. TABs, newlines and '\'
are escaped with '\', so: '\n', '\t', and '\\'. Other whitespace characters
@@ -171,6 +170,7 @@ Find RSS/Atom feed urls from a webpage:
url="codemadness.org"; curl -L -s "$url" | sfeed_web "$url"
output:
+
http://codemadness.org/blog/rss.xml application/rss+xml
http://codemadness.org/blog/atom.xml application/atom+xml