[TS] Add a socket handling implementation that uses Node.JS's `net`
[ldk-java] / README.md
index 4c937681b77b79dd713e8a79d0227934fd913377..7affd5307490395cef8136c3511900f6f23fc576 100644 (file)
--- a/README.md
+++ b/README.md
@@ -62,6 +62,11 @@ The TypeScript bindings require modern web standards, including support for `Fin
 and `WeakRef` (Chrome 84, Firefox 79, Safari 14.1/iOS 14.5 and Node 14.6) and WASM BigInt support
 (Chrome 85, Firefox 78, Safari 14.1/iOS 14.5, and Node 15.0).
 
+For users of Node.JS environments you may wish to use the `lightningdevkit-node-net` package as
+well to implement the required network handling to bridge the `lightningdevkit` package's
+`SocketDescriptor` interface to Node.JS TCP Sockets. For those wishing to run a lightning node in
+the browser you will need to provide your own bridge from `SocketDescriptor` to a WebSocket proxy.
+
 ## General
 
 The only known issue resulting in a use-after-free bug requires custom a custom ChannelKeys instance