From: Ramakrishnan Muthukrishnan Date: Sun, 10 Jul 2016 07:56:05 +0000 (+0530) Subject: README: update current status X-Git-Url: https://git.rkrishnan.org/%5B/%5D%20/uri/flags/%22doc.html//%22%22.?a=commitdiff_plain;h=f94d4d86f50176ba633b9031b307ce4c26af5fae;p=functorrent.git README: update current status --- diff --git a/README.md b/README.md index 869cd3c..457a754 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # A command line BitTorrent client. -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. +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. ### Building @@ -36,23 +39,28 @@ Or one can explicitly specify the torrent file as input. - doctest and quickcheck tests. - Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md +### 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. + ### Current Status - most of the peer wire protocol works. - talks only to one peer at the moment. - can download files. But needs every piece to be served by the peer it connected to. +- can talk to http/udp trackers. -### 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 +### TODO -* Test suite. -* Talk to multiple peers concurrently. -* Piece download algorithms. -* Multifile torrent support. -* other advanced features of BitTorrent (like DHT). +- Test suite. +- Talk to multiple peers concurrently. +- Piece download algorithms. +- Multifile torrent support. +- Magnet link support. +- other advanced features of BitTorrent (like DHT). ### Misc