description

1 files changed, 17 insertions, 4 deletions

diff --git a/dput-hslogger/dput-hslogger.cabal b/dput-hslogger/dput-hslogger.cabal
index 0ddb75ba..f5be9f96 100644
--- a/dput-hslogger/dput-hslogger.cabal
+++ b/dput-hslogger/dput-hslogger.cabal
@@ -1,10 +1,23 @@
--- Initial dput-hslogger.cabal generated by cabal init.  For further
--- documentation, see http://haskell.org/cabal/users-guide/
-
 name:                dput-hslogger
 version:             0.1.0.0
 synopsis:            Quick and dirty debug prints indexed by user Enum type.
--- description:
+description:
+
+    This package is the first of possibly many to provide log messages with the
+    'dput' command. It is implemented as a wrapper around hslogger.  Libraries
+    which depend on this library, should contain a non-exposed module called
+    DebugTag with a datatype 'DebugTag' which implements Enum and Show. The
+    intention is to make it easy to cut and paste code between projects which may
+    or may not both use hslogger, but do both use some library which implements the
+    dput interface. The tags used can be library or module specific, or simply
+    specify conventional debug level information like info,debug,error.
+
+    Users may wish to get started developing immediately and keep their options
+    open with regard to logging.  For which case, the dput convention will be
+    helpful. They may even decide to make their own dput backend. It is easy to do
+    as the API is very small. The simplest backend would merely output to stderr.
+
+
 license:             BSD3
 license-file:        LICENSE
 author:              James Crayne