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

update docs/api.md for 0.4.0

Browse Source
This commit is contained in:
Brian Warner 2015-09-22 01:27:17 -07:00
parent bc1142586e
commit d76893c07e
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

@ -50,7 +50,7 @@ which.
The synchronous+blocking flow looks like this: The synchronous+blocking flow looks like this:
```python ```python
from wormhole.transcribe import Wormhole from wormhole.blocking.transcribe import Wormhole
from wormhole.public_relay import RENDEZVOUS_RELAY from wormhole.public_relay import RENDEZVOUS_RELAY
mydata = b"initiator's data" mydata = b"initiator's data"
i = Wormhole("appid", RENDEZVOUS_RELAY) i = Wormhole("appid", RENDEZVOUS_RELAY)
@ -62,7 +62,7 @@ print("Their data: %s" % theirdata.decode("ascii"))
```python ```python
import sys import sys
from wormhole.transcribe import Wormhole from wormhole.blocking.transcribe import Wormhole
from wormhole.public_relay import RENDEZVOUS_RELAY from wormhole.public_relay import RENDEZVOUS_RELAY
mydata = b"receiver's data" mydata = b"receiver's data"
code = sys.argv[1] code = sys.argv[1]
@ -197,7 +197,7 @@ restarted during that time. To support this, you can persist the state of the
object by calling `data = w.serialize()`, which will return a printable object by calling `data = w.serialize()`, which will return a printable
bytestring (the JSON-encoding of a small dictionary). To restore, use the bytestring (the JSON-encoding of a small dictionary). To restore, use the
`from_serialized(data)` classmethod (e.g. `w = `from_serialized(data)` classmethod (e.g. `w =
SymmetricWormhole.from_serialized(data)`). Wormhole.from_serialized(data)`).
There is exactly one point at which you can serialize the wormhole: *after* There is exactly one point at which you can serialize the wormhole: *after*
establishing the invitation code, but before waiting for `get_verifier()` or establishing the invitation code, but before waiting for `get_verifier()` or