beginning of the filesystem module

[functorrent.git] / README.md

diff --git a/README.md b/README.md
index 77146811c5bde3afbb0af6fc7517e8c7cb5ec68c..13962894869aaf2b6252a4d803b724fdbeafd4e1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,45 +1,5 @@
-# A bittorrent client.
+# functorrent
 
-[![Build Status](https://travis-ci.org/vu3rdd/functorrent.svg?branch=master)](https://travis-ci.org/vu3rdd/functorrent)
+[![Build Status](https://travis-ci.org/vu3rdd/functorrent.png)](https://travis-ci.org/vu3rdd/functorrent)
 
-## building
-
-I suggest using cabal sandbox.
-
-Or you can use Nix pkg, in which case, typing `nix-shell' at the root of the
-source code repo should drop you into a shell which has all the package
-dependencies installed.
-
-### Steps:
-
-clone the repo; cd functorrent;
-
-    $ cabal sandbox init
-    $ wget http://www.stackage.org/lts/cabal.config
-    $ cabal install --only-dependencies --enable-tests
-    $ cabal build # binaries in ./dist/built/functorrent/*
-
-## Goals
-
-- Become more profient with Haskell.
-- Implement something non-trivial with Haskell (crypto, file operations, network
-  operations, concurrency, bit twiddling, DHT).
-- 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
-
-## Current Status
-
-- 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).
+TODO Description.