Update README.md
Jeromy Johnson committed
Dec 4, 2014 at 21:48 UTC
260ac9617585e47fde73835729ea5e9716c3d16f
1 file changed
+11
-10
exchange/bitswap/README.md
+11
-10
@@ -1,4 +1,5 @@
1
-#Welcome to Bitswap (The data trading engine)
1
+#Welcome to Bitswap
2
+###(The data trading engine)
3
4
Bitswap is the module that is responsible for requesting and providing data
5
blocks over the network to and from other ipfs peers. The role of bitswap is
@@ -7,15 +8,15 @@ to be a merchant in the large global marketplace of data.
8
##Main Operations
9
Bitswap has three high level operations:
10
10
-###GetBlocks
11
-`GetBlocks` is a bitswap method used to request multiple blocks that are likely
11
+- **GetBlocks**
12
+ - `GetBlocks` is a bitswap method used to request multiple blocks that are likely
13
to all be provided by the same set of peers (part of a single file, for example).
14
14
-###GetBlock
15
-`GetBlock` is a special case of `GetBlocks` that just requests a single block.
15
+- **GetBlock**
16
+ - `GetBlock` is a special case of `GetBlocks` that just requests a single block.
17
17
-###HasBlock
18
-`HasBlock` registers a local block with bitswap. Bitswap will then send that
18
+- **HasBlock**
19
+ - `HasBlock` registers a local block with bitswap. Bitswap will then send that
20
block to any connected peers who want it (with the strategies approval), record
21
that transaction in the ledger and announce to the DHT that the block is being
22
provided.
@@ -41,6 +42,6 @@ If another peers wantlist is received, Bitswap will call its strategies
42
be sent the block they are requesting (if we even have it).
43
44
##Outstanding TODOs:
44
-[] Ensure only one request active per key
45
-[] More involved strategies
46
-[] Ensure only wanted blocks are counted in ledgers
45
+- [ ] Ensure only one request active per key
46
+- [ ] More involved strategies
47
+- [ ] Ensure only wanted blocks are counted in ledgers