summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Truzjan <pxqr.sta@gmail.com>2014-04-26 05:29:48 +0400
committerSam Truzjan <pxqr.sta@gmail.com>2014-04-26 05:29:48 +0400
commit4587ffd5406162bb06a6549ffd2ff277e0a93916 (patch)
tree88f0c54df00eb0def7fe1a13fc7b3be31cab4c73
parent20893960b74ca8043f8377975f25a0d0662c1a6b (diff)
Update README
-rw-r--r--BEP.md61
-rw-r--r--README.md80
2 files changed, 65 insertions, 76 deletions
diff --git a/BEP.md b/BEP.md
deleted file mode 100644
index 12693ce1..00000000
--- a/BEP.md
+++ /dev/null
@@ -1,61 +0,0 @@
1The protocol has [many extensions][bep-list] (more precisely
2enchancements, but we'll use that word) and it's seems like no one
3will want to use just core protocol, at least I'm not. Any modern
4application that uses bittorrent protocol in any way will use some
5subset of extensions. Thus it's reasonable to implement at least some
6part of widely used extensions here, so we could provide nice high
7level API and well integrated interface.
8
9This section should keep track current state of package in respect of
10BEP's. Please _don't_ use this list as issue or bug tracker or TODO
11list or anything else: when in doubt don't change the table.
12
13In order to keep table compact we describe table layout at first:
14
15* **BEP #** — Just number of enchancement.
16* **Title** — Full official enchancement name.
17* **Status** — is the current state of the BEP. Status lifecycle has
18 the only way: Want -> In Progress -> Implemented.
19
20We should try keep table in order of priority, so first BEPs should be
21are most important and last BEPs are least important. (but important
22too)
23
24| BEP # | Title | Status
25|:-----:|:--------------------------------------------------:|:-----------
26| 3 | [The BitTorrent Protocol Specification][bep3] | [In progress][bep3-impl]
27| 4 | [Known Number Allocations][bep4] | [In progress][bep4-impl]
28| 5 | [DHT][bep5] | [In progress][bep5-impl]
29| 6 | [Fast Extension][bep6] | [In progress][bep6-impl]
30| 7 | [IPv6 Tracker Extension][bep7] | [In progress][bep7-impl]
31| 9 | [Extension for Peers to Send Metadata Files][bep9] | [In progress][bep9-impl]
32| 10 | [Extension protocol][bep10] | [In progress][bep10-impl]
33| 12 | [Multitracker Metadata Extension][bep10] | [In progress][bep12-impl]
34| 15 | [UDP Tracker Protocol for BitTorrent][bep15] | [In progress][bep15-impl]
35| 20 | [Peer ID Conventions][bep20] | [Implemented][bep20-impl]
36| 23 | [Tracker Return Compact Peer Lists][bep23] | [Implemented][bep23-impl]
37
38[bep-list]: http://www.bittorrent.org/beps/bep_0000.html
39[bep3]: http://www.bittorrent.org/beps/bep_0003.html
40[bep4]: http://www.bittorrent.org/beps/bep_0004.html
41[bep5]: http://www.bittorrent.org/beps/bep_0005.html
42[bep6]: http://www.bittorrent.org/beps/bep_0006.html
43[bep7]: http://www.bittorrent.org/beps/bep_0007.html
44[bep9]: http://www.bittorrent.org/beps/bep_0009.html
45[bep10]: http://www.bittorrent.org/beps/bep_0010.html
46[bep12]: http://www.bittorrent.org/beps/bep_0012.html
47[bep15]: http://www.bittorrent.org/beps/bep_0015.html
48[bep20]: http://www.bittorrent.org/beps/bep_0020.html
49[bep23]: http://www.bittorrent.org/beps/bep_0023.html
50
51[bep3-impl]: src
52[bep4-impl]: src/Network/BitTorrent/Exchange/Message.hs
53[bep5-impl]: src/Network/BitTorrent/DHT/Protocol.hs
54[bep6-impl]: src/Network/BitTorrent/Exchange/Message.hs
55[bep7-impl]: src/Network/BitTorrent/Tracker/Message.hs
56[bep9-impl]: src/Network/BitTorrent/Exchange/Wire.hs
57[bep10-impl]: src/Network/BitTorrent/Exchange/Message.hs
58[bep12-impl]: src/Data/Torrent.hs
59[bep15-impl]: src/Network/BitTorrent/Tracker/RPC/UDP.hs
60[bep20-impl]: src/Network/BitTorrent/Core/Fingerprint.hs
61[bep23-impl]: src/Network/BitTorrent/Tracker/Message.hs
diff --git a/README.md b/README.md
index ee7823b6..32948896 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,78 @@
1### Synopsis 1### BitTorrent [![Build Status][1]][2]
2 2
3A library for making Haskell applications which use bittorrent 3A [BitTorrent][0] library implementation. It allows to read/write
4protocol easy. Currently it provides serialization and deserealization 4torrent files, transfer data files, query trackers and DHT. The
5of core datatypes, some widely used routines and core types. 5library is still in active development and have some subsystems
6partially implemented.
7
8For lastest released version and reference documentation see [hackage][3] page.
9
10[0]: http://bittorrent.org/beps/bep_0000.html
11[1]: https://travis-ci.org/cobit/bittorrent.png
12[2]: https://travis-ci.org/cobit/bittorrent
13[3]: http://hackage.haskell.org/package/bittorrent
6 14
7### Status 15### Status
8 16
9See list of implemented [BEPs](BEP.md). 17The protocol has [many enchancements][bep-list]. This table keep track
18if a particular BEP is "todo", "in progress" or "complete":
10 19
11### Documentation 20| BEP # | Title | Status
21|:-----:|:--------------------------------------------------:|:-----------
22| 3 | [The BitTorrent Protocol Specification][bep3] | [In progress][bep3-impl]
23| 4 | [Known Number Allocations][bep4] | [In progress][bep4-impl]
24| 5 | [DHT][bep5] | [In progress][bep5-impl]
25| 6 | [Fast Extension][bep6] | [In progress][bep6-impl]
26| 7 | [IPv6 Tracker Extension][bep7] | [In progress][bep7-impl]
27| 9 | [Extension for Peers to Send Metadata Files][bep9] | [In progress][bep9-impl]
28| 10 | [Extension protocol][bep10] | [In progress][bep10-impl]
29| 12 | [Multitracker Metadata Extension][bep10] | [In progress][bep12-impl]
30| 15 | [UDP Tracker Protocol for BitTorrent][bep15] | [In progress][bep15-impl]
31| 20 | [Peer ID Conventions][bep20] | [Implemented][bep20-impl]
32| 23 | [Tracker Return Compact Peer Lists][bep23] | [Implemented][bep23-impl]
12 33
13For documentation see haddock generated documentation. 34[bep-list]: http://www.bittorrent.org/beps/bep_0000.html
35[bep3]: http://www.bittorrent.org/beps/bep_0003.html
36[bep4]: http://www.bittorrent.org/beps/bep_0004.html
37[bep5]: http://www.bittorrent.org/beps/bep_0005.html
38[bep6]: http://www.bittorrent.org/beps/bep_0006.html
39[bep7]: http://www.bittorrent.org/beps/bep_0007.html
40[bep9]: http://www.bittorrent.org/beps/bep_0009.html
41[bep10]: http://www.bittorrent.org/beps/bep_0010.html
42[bep12]: http://www.bittorrent.org/beps/bep_0012.html
43[bep15]: http://www.bittorrent.org/beps/bep_0015.html
44[bep20]: http://www.bittorrent.org/beps/bep_0020.html
45[bep23]: http://www.bittorrent.org/beps/bep_0023.html
14 46
15### Build Status 47[bep3-impl]: src
48[bep4-impl]: src/Network/BitTorrent/Exchange/Message.hs
49[bep5-impl]: src/Network/BitTorrent/DHT/Protocol.hs
50[bep6-impl]: src/Network/BitTorrent/Exchange/Message.hs
51[bep7-impl]: src/Network/BitTorrent/Tracker/Message.hs
52[bep9-impl]: src/Network/BitTorrent/Exchange/Wire.hs
53[bep10-impl]: src/Network/BitTorrent/Exchange/Message.hs
54[bep12-impl]: src/Data/Torrent.hs
55[bep15-impl]: src/Network/BitTorrent/Tracker/RPC/UDP.hs
56[bep20-impl]: src/Network/BitTorrent/Core/Fingerprint.hs
57[bep23-impl]: src/Network/BitTorrent/Tracker/Message.hs
16 58
17[![Build Status][1]][2] 59### Hacking
18 60
19[1]: https://travis-ci.org/cobit/bittorrent.png 61The root directory layout is as follows:
20[2]: https://travis-ci.org/cobit/bittorrent 62
63* examples -- includes demo utilities to get started;
64* src -- the library source tree;
65* tests -- the library test suite;
66* res -- torrents and data files used in test suite.
67* sub -- subprojects and submodules used by the library and still in dev.
21 68
69Some subdirectories includes README with futher explanations to get started.
22 70
23### Maintainer <pxqr.sta@gmail.com> 71### Contacts
24 72
25Feel free to report bugs and suggestions via 73* Discussions: IRC [#haskell-bittorrent][irc] at irc.freenode.net
26[github issue tracker][issues] or the mail. 74* Bugs & issues: [issue tracker][tracker]
75* Maintainer: <pxqr.sta@gmail.com>
27 76
28[issues]: https://github.com/cobit/bittorrent/issues/new 77[tracker]: https://github.com/cobit/bittorrent/issues/new
78[irc]: http://webchat.freenode.net/?channels=haskell-bittorrent