Add peer package readme

This commit is contained in:
nabarun 2022-12-22 13:54:12 +05:30 committed by prathamesh0
parent e108a5748b
commit d3a924a32b

21
packages/peer/README.md Normal file
View File

@ -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