project renamed to "functorrent"

[functorrent.git] / README

diff --git a/README b/README
index f43b073d2cad94259c1be44a7daccf8cd7cf9ab9..d63a0d3be0d38fd4295fcec34d2eef505fe0fc9e 100644 (file)
--- a/README
+++ b/README
@@ -1,24 +1,4 @@
-From WordNet (r) 3.0 (2006) [wn]:
-
-  deluge
-      n 1: an overwhelming number or amount; "a flood of requests"; "a
-           torrent of abuse" [syn: {flood}, {inundation}, {deluge},
-           {torrent}]
-      2: a heavy rain [syn: {downpour}, {cloudburst}, {deluge},
-         {waterspout}, {torrent}, {pelter}, {soaker}]
-      3: the rising of a body of water and its overflowing onto
-         normally dry land; "plains fertilized by annual inundations"
-         [syn: {flood}, {inundation}, {deluge}, {alluvion}]
-      v 1: fill quickly beyond capacity; as with a liquid; "the
-           basement was inundated after the storm"; "The images
-           flooded his mind" [syn: {deluge}, {flood}, {inundate},
-           {swamp}]
-      2: charge someone with too many tasks [syn: {overwhelm},
-         {deluge}, {flood out}]
-      3: fill or cover completely, usually with water [syn:
-         {inundate}, {deluge}, {submerge}]
-
-`deluge' is a bittorrent client.
+`functorrent' is a bittorrent client.
 
 building
 --------
@@ -29,7 +9,7 @@ Steps:
 
 1. cabal sandbox init
 2. cabal install --only-dependencies
-3. cabal build # binaries in ./dist/built/deluge/*
+3. cabal build # binaries in ./dist/built/functorrent/*
 
 Goals
 -----
@@ -37,9 +17,10 @@ Goals
 - Become more profient with Haskell.
 - Implement something non-trivial with Haskell (crypto, file operations, network
   operations, concurrency, bit twiddling, DHT).
-- Spec compliance.
+- Follow the spec. (<https://wiki.theory.org/BitTorrentSpecification>)
 - Easy for newbies like me to read and understand along side the spec.
 - doctest and quickcheck tests.
+- Follow Haskell Style Guide (<https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md>)
 
 Status
 ------