diff options
author | Sam T <pxqr.sta@gmail.com> | 2013-06-06 15:09:02 +0400 |
---|---|---|
committer | Sam T <pxqr.sta@gmail.com> | 2013-06-06 15:09:02 +0400 |
commit | 638ffee180b444c6c8d769fa8c95d151a44b7962 (patch) | |
tree | b5e73754ff0494804817e55d67f3fb28c8a3d2f7 /README.md | |
parent | fae03068201faf01f2337e8778cc2cd744a6483d (diff) |
~ Update readme.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 54 |
1 files changed, 31 insertions, 23 deletions
@@ -1,27 +1,24 @@ | |||
1 | # Synopsis | 1 | ### Synopsis |
2 | 2 | ||
3 | This package aims to provide a thin layer for bittorrent protocol. | 3 | A library for making Haskell applications which use bittorrent |
4 | Basically it provides serialization\deserealization and some widely | 4 | protocol easy. This package aims to be a fast thin layer and at the |
5 | used routines. | 5 | same 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 | 10 | Currently it provides serialization and deserealization of core |
11 | datatypes, some widely used routines and core types. | ||
10 | 12 | ||
11 | The 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 | 16 | The protocol has many extensions(more precisely enchancements, but |
19 | 17 | we'll use that word) and it's seems like no one will want to use just | |
20 | The protocol has many extensions[1] and it's seems like no one want to | 18 | core protocol, at least I'm not. Any modern application that uses |
21 | use just core protocol, at least I'm not. Any modern application that | 19 | bittorrent protocol in any way will use some subset of extensions. |
22 | uses bittorrent protocol in any way will use some subset of extensions | 20 | Thus it's reasonable to implement at least some part of widely used |
23 | anyway. Thus it's reasonable to implement at least some part of widely | 21 | extensions here, so we could provide nice high level API and well |
24 | used extensions here, so we could provide nice high level API and well | ||
25 | integrated interface. | 22 | integrated interface. |
26 | 23 | ||
27 | This section should keep track current state of package in respect of | 24 | This 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 | |||
65 | For 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 | ||
78 | This library is written and maintained by Sam T. <pxqr.sta@gmail.com> | ||
72 | 79 | ||
73 | ### Footnotes | 80 | Feel 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 |