[C#] Set license URL to the deprecated marker, fix file path

[ldk-java] / README.md

diff --git a/README.md b/README.md
index 825c22c716380b2e71be5275842ac9507ad70cbd..4189b966803f4a606706771bb547673a7497e7ef 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
@@ -39,19 +39,31 @@ To build for Apple M1 (ie aarch64-apple-darwin), you probably want something lik
 Status
 ======
 
-The TypeScript Bindings are still in early development and generated code contains syntax errors.
+## Java
 
-While the underlying library and C bindings are relatively mature, the Java bindings should be
-considered beta quality and some issues may still appear. Specifically, because the Java bindings
-map between two very different memory models - Rust's strict ownership model and Java's reference
-cloning and garbage collection - a lot of work occurs in the background to keep the Java GC
-informed of Rust ownership semantics.
+The Java bindings are relatively mature, and should be considered safe for production use. Still,
+as they have relatively few users, unexpected issues remain possible, and bug reports are welcome.
 
-The debug-mode build includes memory leak tracking and will print all loose objects when the
-program exists, though without calls to `System.gc(); System.runFinalization();` immediately before
-exit there will likely be many false positives. While it will require some complicated usage, there
-are likely some use-after-free or unkonwn-free bugs remaining. The debug-mode build links LLVM
-address sanitizer and will print diagnostic information in case of such issues.
+## TypeScript
+
+The TypeScript bindings are functionally complete, but should be considered beta quality. As there
+are relatively few users, unexpected issues remain likely, and bug reports are welcome.
+
+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 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.
+
+# C#
+
+The C# bindings are functionally complete, but should be considered alpha quality. They are brand
+new and likely contain bugs or memory leaks.
+
+## General
 
 The only known issue resulting in a use-after-free bug requires custom a custom ChannelKeys instance
 created as a part of a new channel. After the channel is created, the ChannelKeys object will not