Update docs

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Bigmap for Java
 
 ## 1.1.0 - 2025-01-22
- - Bump tokyocabinet v0.0.16
- - Bump tkrzw v0.0.9
+ - Bump tokyocabinet v0.0.16 (new support for freebsd/openbsd)
+ - Bump tkrzw v0.0.9 (new support for freebsd/openbsd)
  - Bump rocksdb v9.8.4
  - Bump kryo v5.6.2 
 

README.md

@@ -56,7 +56,7 @@ Project sponsors may include the following benefits:
 ## Usage
 
 With many of our implementations (e.g. rocksdb or leveldb), you can simply use the dependency below and add it to
-your maven POM file.  However, with tokyocabinet, there are many native libs you will need to include. To simplify
+your maven POM file.  However, with tokyocabinet or tkrzw, there are many native libs you will need to include. To simplify
 managing these versions, you should consider importing our bill-of-materials BOM.
 
 ```xml
@@ -87,8 +87,26 @@ Then to use tokyocabinet implementation, add the following:
     <groupId>com.fizzed</groupId>
     <artifactId>tokyocabinet-linux-x64</artifactId>
     <!-- you can omit the version if you used our BOM above -->
+    <version>VERSION-HERE</version>
+</dependency>
+```
+
+Then to use tkrzw implementation, add the following:
+
+```xml
+<dependency>
+    <groupId>com.fizzed</groupId>
+    <artifactId>bigmap-tkrzw</artifactId>
+    <!-- you can omit the version if you used our BOM above -->
     <version>1.0.16</version>
 </dependency>
+
+<dependency>
+    <groupId>com.fizzed</groupId>
+    <artifactId>tkrzw-linux-x64</artifactId>
+    <!-- you can omit the version if you used our BOM above -->
+    <version>VERSION-HERE</version>
+</dependency>
 ```
 
 Or for rocksdb
@@ -276,6 +294,6 @@ Total disk used: 24135 (MB)
 
 ## License
 
-Copyright (C) 2020+ Fizzed, Inc.
+Copyright (C) 2025 Fizzed, Inc.
 
 This work is licensed under the Apache License, Version 2.0. See LICENSE for details.

bigmap-bom/pom.xml

@@ -65,6 +65,15 @@
                 <scope>import</scope>
             </dependency>
 
+            <!-- this will make it easy for consumers of this lib to get the natives they need -->
+            <dependency>
+                <groupId>com.fizzed</groupId>
+                <artifactId>tkrzw-bom</artifactId>
+                <version>${tkrzw.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+
         </dependencies>
     </dependencyManagement>
 

buildx-results.txt

@@ -1,8 +1,8 @@
 Buildx Results
 --------------
 Cross platform tests use the Buildx project: https://github.com/fizzed/buildx
-Commit: f325739624dddcca4f1ebf34198f0d82ffd0ee1d
-Date: 2025-01-10T19:11:27.113751Z[UTC]
+Commit: 3bf372e98ed892e440dfa1cdd859b8f128c0f03f
+Date: 2025-01-22T17:01:19.227687Z[UTC]
 
 linux-x64                                                         success
 linux-arm64                                                       success