diff --git a/packages/peer/README.md b/packages/peer/README.md new file mode 100644 index 00000000..44774aa8 --- /dev/null +++ b/packages/peer/README.md @@ -0,0 +1,21 @@ +# peer + +Package used for connecting between peers and send messages + +## Implementations + +- [x] Discover peers +- [x] Connect between peers and send messages +- [x] Use package in browser +- [ ] Use package in server +- [ ] Send messages between systems in different LANs + +## Issues + +- Error is thrown when connecting peers in different LANs + ``` + AggregateError: All promises were rejected + ``` + According to stack trace error is thrown in [@libp2p/mplex](https://github.com/libp2p/js-libp2p-mplex) package + +- `peer:disconnect` event is not fired when remote peer browser is closed