From 5671d214dfa65c71d19a0f8f0f9764df21845a4b Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 23 Dec 2013 11:14:29 -0500 Subject: [PATCH] Add a better Cabal description. --- htsn.cabal | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) 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 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: -- 2.44.2