Merge pull request #123 from tnull/patch-1

[ldk-java] / README.md

diff --git a/README.md b/README.md
index 793d2ce8cf78f03086cf0598a2e9cf88119afb35..27e2e51e142f2aff2aad9487149b05544aacc6f5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ A release build of the Java bindings library for Linux is available in git. Thus
 
 To build the bindings locally, the bindings require some additional work which is still making its
 way upstream, for now it should be built against the
-[rust-lightning 2021-03-java-bindings-base branch on git.bitcoin.ninja](https://git.bitcoin.ninja/?p=rust-lightning;a=shortlog;h=refs/heads/2021-03-java-bindings-base).
+[rust-lightning 2022-10-112-java-bindings branch on git.bitcoin.ninja](https://git.bitcoin.ninja/?p=rust-lightning;a=shortlog;h=refs/heads/2022-10-112-java-bindings).
 Check that branch out locally as well as [ldk-c-bindings](https://github.com/lightningdevkit/ldk-c-bindings)
 and run the `genbindings.sh` script in ldk-c-bindings to build the required binaries. Thereafter,
 in this repo, run the `genbindings.sh` script with the first argument pointing to the ldk-c-bindings
@@ -60,7 +60,12 @@ Some functions may error spuriously due to oversights or missing implementations
 
 The TypeScript bindings require modern web standards, including support for `FinalizationRegistry`
 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 ??).
+(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