]> git.bitcoin.ninja Git - ldk-java/commitdiff
Simplify and make less scary the current status listing
authorMatt Corallo <git@bluematt.me>
Fri, 6 Oct 2023 00:36:19 +0000 (00:36 +0000)
committerMatt Corallo <git@bluematt.me>
Sat, 7 Oct 2023 17:23:07 +0000 (17:23 +0000)
Fixes #137.

README.md

index 27e2e51e142f2aff2aad9487149b05544aacc6f5..ed88ceba2f64831f57ee30f7254ffe5ee8ff8aa3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -41,22 +41,13 @@ Status
 
 ## 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 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.
+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.
 
 ## TypeScript
 
-The TypeScript bindings are functionally complete, but should be considered early alpha quality.
-Some functions may error spuriously due to oversights or missing implementations.
+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