beginning of the filesystem module

[functorrent.git] / README.md

diff --git a/README.md b/README.md
index 927b9872c160ad6738c3076b04e64596b9c6b4b2..13962894869aaf2b6252a4d803b724fdbeafd4e1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,75 +1,5 @@
-# A command line BitTorrent client.
+# functorrent
 
-I started writing a BitTorrent client because it seemed like fun and I am learning Haskell and wanted to see if I can write something real with Haskell than just heat the room. It is turning out to be a lot of fun.
+[![Build Status](https://travis-ci.org/vu3rdd/functorrent.png)](https://travis-ci.org/vu3rdd/functorrent)
 
-[![Join the chat at https://gitter.im/vu3rdd/functorrent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vu3rdd/functorrent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-## Building
-
-Functorrent can be build with [Stack](https://github.com/commercialhaskell/stack) or
-[Nix](https://nixos.org/nix/). I personally test the build with Debian GNU/Linux and
-OS X using FP Complete's stack.
-
-### Stack
-
-Sandboxes give you per project independent containers, just like Python's
-virtualenv.
-
-
-    $ git clone https://github.com/vu3rdd/functorrent && cd functorrent
-    $ cabal install stack # or install stack by other means
-    $ stack build # binaries in $(pwd)/.stack-work/install/x86..../lts-2.16/7.8.4/bin/functorrent
-
-### Building with Nix
-
-``$ nix-shell``` at the root of the source code repo should drop you into a
-shell which has all the package dependencies installed.
-
-
-    $ nix-shell --pure
-    [...]
-    [nix-shell] $ cabal configure && cabal build
-
-### Usage
-
-If you invoke functorrent without any options, it expects the contents of a torrent file
-to be given in stdin. So
-
-$ cat ubuntu-14.10-desktop-amd64.iso.torrent | functorrent
-[....]
-
-Or one can explicitly specify the torrent file as input.
-
-$ functorrent ubuntu-14.10-desktop-amd64.iso.torrent
-[...]
-
-## Goals
-
-- [Optimized for Fun](http://www.slideshare.net/autang/ofun-optimizing-for-fun).
-  (should have called it "funtorrent")
-- Become more profient with Haskell.
-- Implement something non-trivial with Haskell (crypto, file operations, network
-  operations, concurrency, bit twiddling, DHT).
-- Follow the spec ([official spec](http://bittorrent.org/beps/bep_0003.html), [unofficial spec](https://wiki.theory.org/BitTorrentSpecification))
-- Easy for newbies like me to read and understand alongside the spec.
-- doctest and quickcheck tests.
-- Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
-
-## Current Status
-
-- most of the peer wire protocol works.
-- talks only to one peer at the moment. Single threaded.
-- can download files. But needs every piece to be served by the peer it connected to.
-
-## WARNING
-
-- this client is not usable as your daily BitTorrent client yet. You may get corrupted files and end up wasting a lot of bandwidth. So, until we achieve some robustness, consider this as a programmer-friendly project to learn about a bunch of stuff.
-
-## TODO
-
-*    Test suite.
-*    Talk to multiple peers.
-*    Piece download algorithms.
-*    Concurrency (threads per peer)
-*    Multifile torrent support.
-*    other advanced features of BitTorrent (like DHT).
+TODO Description.