added trial TODO list
[swift-upb.git] / README
1 swift: the multiparty transport protocol
2     (aka BitTorrent at the transport layer)
3     Differently from TCP, the protocol does not use the ordered data stream
4     abstraction. Effectively, it splits a file into 1KB packets and sends
5     them around. The secret sauce is Merkle hash trees and binmaps.
6
7 see doc/index.html for marketing stuff, ideas and rants
8     doc/swift.txt for protocol draft spec
9     *.cpp for the actual code
10     swift.cpp is the main exec file; may run as e.g.
11     
12         ./swift -t node300.das2.ewi.tudelft.nl:20000 -h \
13         d1502706c46779d361a1d562a10da0a45c4c40e5 -f \
14         trailer.ogg
15         
16     ...to retrieve video and save it to a file, or...
17
18         ./swift -t mfold.libswift.org:20000 -h \
19         d1502706c46779d361a1d562a10da0a45c4c40e5 -r . \
20         -h 8080
21         
22     ...and then point your browser at
23     
24         http://localhost:8080/d1502706c46779d361a1d562a10da0a45c4c40e5