X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn.git;a=blobdiff_plain;f=htsn.cabal;h=74a789f5856ed9c2d37cd38b49b56cb22b330ee9;hp=a59f2df0d337fb11f63285d4efa851ad04e7bef5;hb=5671d214dfa65c71d19a0f8f0f9764df21845a4b;hpb=67062e7c47c1cc949a99c8cb20cd0e696c097e15

diff --git a/htsn.cabal b/htsn.cabal
index a59f2df..74a789f 100644
--- a/htsn.cabal
+++ b/htsn.cabal
@@ -12,7 +12,25 @@ extra-source-files:
 synopsis:
   Parse XML files from The Sports Network feed.
 description:
-  Parse XML files from The Sports Network feed.
+  The Sports Network <http://www.sportsnetwork.com/> offers an XML feed
+  containing various sports news and statistics. The goal of /htsn/
+  is to watch the XML feed and parse the individual XML documents into
+  files.
+  .
+  Once started, we will choose an XML feed host to connect to. The
+  choice is made from a list in a round-robin fashion, and by default,
+  the list contains all known TSN feed hosts. Once we have a connection,
+  your username and password are sent. If they are accepted, we begin to
+  parse the feed saving all XML files to the configured output directory.
+  .
+  If we encounter an error (say, the connection is dropped), then we
+  will attempt to connect to the next host in the list after waiting
+  five seconds. This process continues indefinitely.
+  .
+  The program can run either interactively (that is, outputting to the
+  console), or as a daemon.
+  .
+  /Full documentation can be found in the included man page./
 
 executable htsn
   build-depends: