Skip to content

Commit b1130e2

Browse files
authored
Update UPGRADE.md
1 parent a351bc1 commit b1130e2

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

UPGRADE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
If you're migrating from `corestore-swarm-networking` v5 to `@corestore/networker` v1, there have been a few breaking changes to be aware of:
22

3-
### `join`/`leave` -> `configure`
3+
#### `join`/`leave` -> `configure`
44
`join` and `leave` have been replaced by a single method, `configure`, which takes the options `announce`, `lookup`, and `flushed`.
55

66
Using `configure`, a `join` is `configure(discoveryKey, { announce: true, lookup: true }` and a `leave` is `configure(discoveryKey, { announce: false, lookup: false })`
77

8-
### The `status` method
8+
#### The `status` method
99
The `status` method previously just fowarded Hyperswarm's `status`. It now returns the current network configuration for a given discovery key. To get the Hyperswarm status directly, you can do `networker.swarm.status`.
1010

11-
### Other Assorted Changes
11+
#### Other Assorted Changes
1212
* The public `streams` and `peers` properties are now `Set`s instead of Arrays.

0 commit comments

Comments
 (0)