Add a little more documentation.

[dead/htsn-common.git] / htsn-common.cabal

diff --git a/htsn-common.cabal b/htsn-common.cabal
index e5f6939e49b85dd9a5bea85928005befbf81a9de..06b36b069645d88dfb332fb22fe1a78f04fd5940 100644 (file)
--- a/htsn-common.cabal
+++ b/htsn-common.cabal
@@ -8,7 +8,7 @@ license:        GPL-3
 license-file:   doc/LICENSE
 build-type:     Simple
 synopsis:
-  Library used by both htsn and htsn-import.
+  Display/logging facilities used by both htsn and htsn-import.
 description:
   This library contains three modules,
   .
@@ -20,6 +20,20 @@ description:
   .
   They work together to provide \"reporting\" for the htsn and htsn-import
   executables which both display and log things in the same way.
+  .
+  The Network.Services.TSN.Logging module allows the application to
+  log to syslog, a file, or both. Four convenience functions are
+  provided to log messages at each priority: error, debug, info, and
+  warn.
+  .
+  The Network.Services.TSN.Terminal provides similar functions that
+  instead display messages on the console (terminal). The output is
+  color-coded according to the severity of the message.
+  .
+  The Network.Services.TSN.Report modules contains convenience
+  functions that both log and display informational message. This is
+  what an (optionally interactive) application will usually want to
+  do.
 
 library
   hs-source-dirs: src/