summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam T <pxqr.sta@gmail.com>2013-07-21 11:15:23 +0400
committerSam T <pxqr.sta@gmail.com>2013-07-21 11:15:23 +0400
commit930ca350bafacf1c4c393776f1408293e3beb8d5 (patch)
treecb71f102f7bb0f4daa78e9a25a5ef7ffb322dd93
parent944b8bfb6959944c607a2f9bd7af42fd654e5d32 (diff)
~ Move beps status to separate file.
-rw-r--r--BEP.md45
-rw-r--r--README.md49
2 files changed, 46 insertions, 48 deletions
diff --git a/BEP.md b/BEP.md
new file mode 100644
index 00000000..aca800a5
--- /dev/null
+++ b/BEP.md
@@ -0,0 +1,45 @@
1The protocol has many extensions(more precisely enchancements, but
2we'll use that word) and it's seems like no one will want to use just
3core protocol, at least I'm not. Any modern application that uses
4bittorrent protocol in any way will use some subset of extensions.
5Thus it's reasonable to implement at least some part of widely used
6extensions here, so we could provide nice high level API and well
7integrated 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* **Modules** — modules that _directly_ relates to the BEP. This is where
18 BEP implemented, where we should look for the BEP. If a module has
19 only changes due to integration with the BEP then it _should not_ be
20 listed in the **Modules** list.
21* **Status** — is the current state of the BEP. Status lifecycle has the
22 only way: Want -> Implemented -> Tested -> Integrated -> Done. You
23 might use (A -> B) to indicate intermediate steps. Note that
24 implemented _doesn't_ means that BEP is ready to use, it _will_ be
25 ready to use only after it pass Tested, Integrated and finally
26 becomes Done.
27
28We should try keep table in order of priority, so first BEPs should be
29are most important and last BEPs are least important. (but important
30too)
31
32| BEP # | Title | Modules | Status
33|:-----:|:------------------------------------------:|:------------------------------------|:-----------
34| 3 | The BitTorrent Protocol Specification | Data.Torrent | Implemented
35| | | Network.BitTorrent.Peer |
36| | | Network.BitTorrent.PeerWire |
37| | | Network.BitTorrent.Tracker |
38| 4 | Known Number Allocations | Network.BitTorrent.Extension | Want -> Implemented
39| 20 | Peer ID Conventions | Network.BitTorrent.Peer.ID | Want -> Implemented
40| | | Network.BitTorrent.Peer.ClientInfo |
41| 9 | Extension for Peers to Send Metadata Files | | Want
42| 23 | Tracker Return Compact Peer Lists | Network.BitTorrent.Tracker.Protocol | Implemented
43| | | Network.BitTorrent.PeerWire.Message |
44| 5 | DHT | | Want
45| 6 | Fast Extension | Network.BitTorrent.PeerWire.Message | Want -> Implemented
diff --git a/README.md b/README.md
index 57544a4c..e43bf25b 100644
--- a/README.md
+++ b/README.md
@@ -10,61 +10,14 @@ same time provide both:
10Currently it provides serialization and deserealization of core 10Currently it provides serialization and deserealization of core
11datatypes, some widely used routines and core types. 11datatypes, some widely used routines and core types.
12 12
13
14### Status 13### Status
15 14
16The protocol has many extensions(more precisely enchancements, but 15See list of implemented [BEPs](BEP.md).
17we'll use that word) and it's seems like no one will want to use just
18core protocol, at least I'm not. Any modern application that uses
19bittorrent protocol in any way will use some subset of extensions.
20Thus it's reasonable to implement at least some part of widely used
21extensions here, so we could provide nice high level API and well
22integrated interface.
23
24This section should keep track current state of package in respect of
25BEP's. Please _don't_ use this list as issue or bug tracker or TODO
26list or anything else: when in doubt don't change the table.
27
28In order to keep table compact we describe table layout at first:
29
30* **BEP #** — Just number of enchancement.
31* **Title** — Full official enchancement name.
32* **Modules** — modules that _directly_ relates to the BEP. This is where
33 BEP implemented, where we should look for the BEP. If a module has
34 only changes due to integration with the BEP then it _should not_ be
35 listed in the **Modules** list.
36* **Status** — is the current state of the BEP. Status lifecycle has the
37 only way: Want -> Implemented -> Tested -> Integrated -> Done. You
38 might use (A -> B) to indicate intermediate steps. Note that
39 implemented _doesn't_ means that BEP is ready to use, it _will_ be
40 ready to use only after it pass Tested, Integrated and finally
41 becomes Done.
42
43We should try keep table in order of priority, so first BEPs should be
44are most important and last BEPs are least important. (but important
45too)
46
47| BEP # | Title | Modules | Status
48|:-----:|:------------------------------------------:|:------------------------------------|:-----------
49| 3 | The BitTorrent Protocol Specification | Data.Torrent | Implemented
50| | | Network.BitTorrent.Peer |
51| | | Network.BitTorrent.PeerWire |
52| | | Network.BitTorrent.Tracker |
53| 4 | Known Number Allocations | Network.BitTorrent.Extension | Want -> Implemented
54| 20 | Peer ID Conventions | Network.BitTorrent.Peer.ID | Want -> Implemented
55| | | Network.BitTorrent.Peer.ClientInfo |
56| 9 | Extension for Peers to Send Metadata Files | | Want
57| 23 | Tracker Return Compact Peer Lists | Network.BitTorrent.Tracker.Protocol | Implemented
58| | | Network.BitTorrent.PeerWire.Message |
59| 5 | DHT | | Want
60| 6 | Fast Extension | Network.BitTorrent.PeerWire.Message | Want -> Implemented
61
62 16
63### Documentation 17### Documentation
64 18
65For documentation see haddock generated documentation. 19For documentation see haddock generated documentation.
66 20
67
68### Build Status 21### Build Status
69 22
70[![Build Status][1]][2] 23[![Build Status][1]][2]