Add one-paragraph description.
authorAdam Sampson <ats@offog.org>
Thu, 1 Aug 2013 10:40:24 +0000 (10:40 +0000)
committerAdam Sampson <ats@offog.org>
Thu, 1 Aug 2013 10:40:24 +0000 (10:40 +0000)
NEWS
README

diff --git a/NEWS b/NEWS
index 0c7b64ef487010ec7020cebd9846741ed40c9cdf..a7a52d94bdd2e5b05a72d26f7360a21b82f7b186 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,8 @@
 - rawdog 2.17
 
+Add a one-paragraph description of rawdog to the README file, for use by
+packgers.
+
 Fix some misquoted dashes in the man page (spotted by lintian).
 
 Set LC_ALL=C and TZ=UTC when running tests, in order to get predictable
diff --git a/README b/README
index 00cb37c26a867dc0902c5cded5b6a4e3514e075f..d3f9f17f61f37bc6d4f1aebd0accc250f2a799c5 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,13 @@
 rawdog: RSS Aggregator Without Delusions Of Grandeur
 Adam Sampson <ats@offog.org>
 
-rawdog is an extensible feed aggregator for Unix-like systems, based on
-the Python feedparser module (originally developed by Mark Pilgrim).
+rawdog is a feed aggregator. It supports most common feed formats,
+including all versions of RSS and Atom using feedparser. It runs from
+cron, collects articles from a number of feeds, and generates a static
+HTML page listing the newest articles in date order. It supports
+per-feed customizable update times, and uses ETags, Last-Modified, gzip
+compression, and RFC3229+feed to minimize network bandwidth usage. Its
+behaviour is highly customisable using plugins written in Python.
 
 rawdog has the following dependencies: