summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam T <pxqr.sta@gmail.com>2013-06-06 15:09:02 +0400
committerSam T <pxqr.sta@gmail.com>2013-06-06 15:09:02 +0400
commit638ffee180b444c6c8d769fa8c95d151a44b7962 (patch)
treeb5e73754ff0494804817e55d67f3fb28c8a3d2f7 /README.md
parentfae03068201faf01f2337e8778cc2cd744a6483d (diff)
~ Update readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 31 insertions, 23 deletions
diff --git a/README.md b/README.md
index d685bb5f..57544a4c 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,24 @@
1# Synopsis 1### Synopsis
2 2
3This package aims to provide a thin layer for bittorrent protocol. 3A library for making Haskell applications which use bittorrent
4Basically it provides serialization\deserealization and some widely 4protocol easy. This package aims to be a fast thin layer and at the
5used routines. 5same time provide both:
6 6
7# Description 7* Concise high level API for typical usage scenarious.
8* More straightforward API if you need more fine grained control.
8 9
9## Modules 10Currently it provides serialization and deserealization of core
11datatypes, some widely used routines and core types.
10 12
11The module hierarhy is tend to be:
12 13
13* Data.Torrent — for torrent metainfo, data verification, etc 14### Status
14* Network.BitTorrent.Peer — common peer related types.
15* Network.BitTorrent.PeerWire — peer wire TCP message passing.
16* Network.BitTorrent.Tracker — tracker HTTP message passing.
17 15
18# Status 16The protocol has many extensions(more precisely enchancements, but
19 17we'll use that word) and it's seems like no one will want to use just
20The protocol has many extensions[1] and it's seems like no one want to 18core protocol, at least I'm not. Any modern application that uses
21use just core protocol, at least I'm not. Any modern application that 19bittorrent protocol in any way will use some subset of extensions.
22uses bittorrent protocol in any way will use some subset of extensions 20Thus it's reasonable to implement at least some part of widely used
23anyway. Thus it's reasonable to implement at least some part of widely 21extensions here, so we could provide nice high level API and well
24used extensions here, so we could provide nice high level API and well
25integrated interface. 22integrated interface.
26 23
27This section should keep track current state of package in respect of 24This section should keep track current state of package in respect of
@@ -62,14 +59,25 @@ too)
62| 5 | DHT | | Want 59| 5 | DHT | | Want
63| 6 | Fast Extension | Network.BitTorrent.PeerWire.Message | Want -> Implemented 60| 6 | Fast Extension | Network.BitTorrent.PeerWire.Message | Want -> Implemented
64 61
65# Build Status 62
63### Documentation
64
65For documentation see haddock generated documentation.
66
67
68### Build Status
66 69
67[![Build Status][1]][2] 70[![Build Status][1]][2]
68 71
69[1]: https://travis-ci.org/pxqr/network-bittorrent.png 72[1]: https://travis-ci.org/pxqr/bittorrent.png
70[2]: https://travis-ci.org/pxqr/network-bittorrent 73[2]: https://travis-ci.org/pxqr/bittorrent
74
75
76### Maintainer
71 77
78This library is written and maintained by Sam T. <pxqr.sta@gmail.com>
72 79
73### Footnotes 80Feel free to report bugs and suggestions via
81[github issue tracker][issues] or the mail.
74 82
75[1] More precisely enchancements, but we'll use that word. 83[issues]: https://github.com/pxqr/bittorrent/issues/new