From a73270696831f8d70b5828ab2a35fdad3666db80 Mon Sep 17 00:00:00 2001
From: nabarun <nabarun@deepstacksoft.com>
Date: Thu, 22 Dec 2022 13:54:12 +0530
Subject: [PATCH] Add peer package readme

---
 packages/peer/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 packages/peer/README.md

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