Skip to content

Commit 38755b6

Browse files
better explain id in readme
1 parent c82cc61 commit 38755b6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ Creates a new PlayPeer instance with a specified peer ID and [PeerJS options](ht
9797

9898
### Properties
9999

100+
The `id` is used to distinguish the peer from other peers on the signalling server.
101+
Using a uuid is recommended, but it is also fine to use any other random string. If you're using a public signalling server instance, including
102+
your application's name in the `id` can help to prevent overlap (e.g. your-app-012345abcdef).
103+
100104
- `id`: Peer's unique identifier
101105
- `connectionCount`: Number of active peer connections (without you)
102106
- `getStorage`: Retrieve storage object

0 commit comments

Comments
 (0)