Synopsis & description

1 files changed, 21 insertions, 7 deletions

diff --git a/kad/kad.cabal b/kad/kad.cabal
index 5babda13..d709059c 100644
--- a/kad/kad.cabal
+++ b/kad/kad.cabal
@@ -1,14 +1,28 @@
--- Initial kad.cabal generated by cabal init.  For further documentation,
--- see http://haskell.org/cabal/users-guide/
-
 name:                kad
 version:             0.1.0.0
--- synopsis:
--- description:
+synopsis:            Kademlia implementation used by the dhtd process.
+description:
+
+  Kademlia is a Distributed Hash Table Algorithm, useful for routing in a peer
+  to peer network. In particular, it is the algorithm used by the Bittorrent and
+  ToxChat networks.
+
+  The original intention of this library, was to provide a commons for all
+  implementers and implementations of kademlia.  Mostly however, it's present
+  purpose is as the backbone to the routing done by the dhtd unix daemon, which
+  supports both of the afore named networks. One way to bootstrap a peer to peer
+  network is simply to use an existing one. This can be done by interfacing with
+  dhtd, which is available via the dht-client package.  If however, you wish to
+  form an independent routing network based on the kademlia algorithm, or an
+  alternative to dhtd, then this library may be of interest to you.
+
+  That said, this library is not officially released, and all the usual caveats
+  apply until the 1.0 version is announced.
+
 license:             BSD3
 license-file:        LICENSE
-author:              James Crayne
-maintainer:          jim.crayne@gmail.com
+author:              Joe Crayne, James Crayne
+maintainer:          James Crayne <jim.crayne@gmail.com>
 -- copyright:
 -- category:
 build-type:          Simple