open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Wormhole does not, in fact, have a make-Transit method

Browse Source 
yet
This commit is contained in:
Brian Warner 2017-05-14 18:52:20 -07:00
parent f762e1592f
commit d19b5850cc
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api.md
View File

@ -16,9 +16,9 @@ ID and rendezvous server). Each side can send multiple messages to the other,
but the encrypted data for all messages must pass through (and be temporarily but the encrypted data for all messages must pass through (and be temporarily
stored on) the rendezvous server, which is a shared resource. For this stored on) the rendezvous server, which is a shared resource. For this
reason, larger data (including bulk file transfers) should use the Transit reason, larger data (including bulk file transfers) should use the Transit
class instead. The Wormhole object has a method to create a Transit object class instead. The Wormhole can be used to create a Transit object for this
for this purpose. In the future, Transit will be deprecated, and this purpose. In the future, Transit will be deprecated, and this functionality
functionality will be incorporated directly as a "dilated wormhole". will be incorporated directly as a "dilated wormhole".
A quick example: A quick example: