README: add travis build/test status badge.

[functorrent.git] / README

diff --git a/README b/README
index 928e7db093b6f100967c54c4c1128d45d28a2199..fcde15bd5813a641bc6be4f8a78267af36294eba 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,7 @@
 `functorrent' is a bittorrent client.
 
+[[https://travis-ci.org/vu3rdd/functorrent][file:https://travis-ci.org/vu3rdd/functorrent.svg?branch=master]]
+
 building
 --------
 
@@ -11,7 +13,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,18 +27,19 @@ 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
 ----
 
+- Test suite.
 - Peer protocol.
 - Get the file download working in the simplest possible way.
 - Concurrency (threads per peer)
 - other advanced features of Bit Torrent (like DHT).
-
-