Tests for decode

[functorrent.git] / README

diff --git a/README b/README
index 24b844fe89c31c27072d05b586ad7d224858a014..5ab648c141b8f9cefa75aa5db7c7b6f8c1eb7d40 100644 (file)
--- a/README
+++ b/README
@@ -11,7 +11,7 @@ clone the repo; cd functorrent;
 
 1. cabal sandbox init
 2. wget http://www.stackage.org/lts/cabal.config
-3. cabal install --only-dependencies
+3. cabal install --only-dependencies --enable-tests
 4. cabal build # binaries in ./dist/built/functorrent/*
 
 Goals
@@ -25,11 +25,13 @@ Goals
 - doctest and quickcheck tests.
 - Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
 
-Status
-------
+Current Status
+--------------
 
-- decode torrent files (bencoding)
+- can decode torrent files (bencoding)
 - talk to the tracker and get the peer list
+- the `main' program takes a torrent file (in the local file system) as input and
+  prints the {ip,port} for each peer, after talking to the tracker.
 
 TODO
 ----