watcher-ts/packages/peer/README.md
prathamesh0 6fa3ee28b5
Add mobymask-v2-watcher with integrated relay and peer functionality (#327)
* Add an option to run relay node with watcher server

* Add a v2 mobymask-watcher

* Add an option to run peer node with watcher server

* Ignore ts error when importing types from peer package

* Rename mobymask v2 watcher

* Parse mobymask libp2p messages

* Refactor and add comments

* Add a note in peer package about nodejs exports

* Update copyright
2023-02-20 18:09:06 +05:30

20 lines
501 B
Markdown

# 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
- [x] Use package in server
- [x] Send messages between systems in different LANs using relay node
## Note
- Avoid any nodejs specific exports from this package as it is intented to be used in browser applications as well
## Known Issues
- `peer:disconnect` event is not fired when remote peer browser is closed