docs: update readme files and other documentation

Author: thunderbiscuit

bdk-android/README.md

@@ -1,8 +1,11 @@
 # bdk-android
-This project builds an .aar package for the Android platform that provide Kotlin language bindings for the [`bdk`] library. The Kotlin language bindings are created by the [`bdk-ffi`] project which is included in the root of this repository.
+
+This project builds an .aar package for the Android platform that provide Kotlin language bindings for the [BDK] libraries. The Kotlin language bindings are created by the [`bdk-ffi`] project which is included in the root of this repository.
 
 ## How to Use
-To use the Kotlin language bindings for [`bdk`] in your Android project add the following to your gradle dependencies:
+
+To use the Kotlin language bindings for BDK in your Android project add the following to your gradle dependencies:
+
 ```kotlin
 repositories {
     mavenCentral()
@@ -14,6 +17,7 @@ dependencies {
 ```
 
 ### Snapshot releases
+
 To use a snapshot release, specify the snapshot repository url in the `repositories` block and use the snapshot version in the `dependencies` block:
 ```kotlin
 repositories {
@@ -26,49 +30,48 @@ dependencies {
 ```
 
 ### Example Projects
-* [bdk-kotlin-example-wallet](https://github.com/bitcoindevkit/bdk-kotlin-example-wallet)
-* [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet)
+
+* [Devkit Wallet](https://github.com/bitcoindevkit/devkit-wallet)
 * [Padawan Wallet](https://github.com/thunderbiscuit/padawan-wallet)
 
 ### How to build
-_Note that Kotlin version `1.9.23` or later is required to build the library._
+
+_Note that Kotlin version `2.1.10` or later is required to build the library._
 
 1. Clone this repository.
 ```shell
 git clone https://github.com/bitcoindevkit/bdk-ffi
 ```
-2. Follow the "General" bdk-ffi ["Getting Started (Developer)"] instructions. 
-3. Install Android SDK and Build-Tools for API level 30+
-4. Setup `ANDROID_SDK_ROOT` and `ANDROID_NDK_ROOT` path variables which are required by the build tool. Note that currently, NDK version 25.2.9519653 or above is required. For example:
+2. Install Android SDK and Build-Tools for API level 30+
+3. Setup `ANDROID_SDK_ROOT` and `ANDROID_NDK_ROOT` path variables which are required by the build tool. Note that currently, NDK version 25.2.9519653 or above is required. For example:
 ```shell
 # macOS
 export ANDROID_SDK_ROOT=~/Library/Android/sdk
 export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.2.9519653
 
-# linux
+# Linux
 export ANDROID_SDK_ROOT=/usr/local/lib/android/sdk
 export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.2.9519653
 ```
-
-7. Build kotlin bindings
+4. Build Kotlin bindings
 ```sh
 # build Android library
 cd bdk-android
 bash ./scripts/build-<your-local-architecture>.sh
 ```
-
-8. Start android emulator and run tests
+5. Start android emulator and run tests
 ```sh
 ./gradlew connectedAndroidTest
 ```
 
 ## How to publish to your local Maven repo
+
 ```shell
 cd bdk-android
 ./gradlew publishToMavenLocal -P localBuild
 ```
 
-Note that the commands assume you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so:
+Note that the command above assumes you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so:
 ```properties
 signing.gnupg.keyName=<YOUR_GNUPG_ID>
 signing.gnupg.passphrase=<YOUR_GNUPG_PASSPHRASE>
@@ -80,20 +83,26 @@ and use the `publishToMavenLocal` task without the `localBuild` flag:
 ```
 
 ## Known issues
+
 ### JNA dependency
+
 Depending on the JVM version you use, you might not have the JNA dependency on your classpath. The exception thrown will be
+
 ```shell
 class file for com.sun.jna.Pointer not found
 ```
+
 The solution is to add JNA as a dependency like so:
+
 ```kotlin
 dependencies {
     implementation("net.java.dev.jna:jna:5.12.1")
 }
 ```
 
 ### x86 emulators
+
 For some older versions of macOS, Android Studio will recommend users install the x86 version of the emulator by default. This will not work with the bdk-android library, as we do not support 32-bit architectures. Make sure you install an x86_64 emulator to work with bdk-android.
 
-[`bdk`]: https://github.com/bitcoindevkit/bdk
+[BDK]: https://github.com/bitcoindevkit/
 [`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi

bdk-android/lib/README.md

@@ -4,4 +4,4 @@ The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Ko
 
 # Package org.bitcoindevkit
 
-The types coming from BDK directly. The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), and [bdk_esplora](https://crates.io/crates/bdk_esplora) crates.
+The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), [bdk_esplora](https://crates.io/crates/bdk_esplora), [bitcoin](https://crates.io/crates/bitcoin), and [miniscript](https://crates.io/crates/miniscript) crates.

bdk-jvm/README.md

@@ -1,8 +1,9 @@
 # bdk-jvm
-This project builds a .jar package for the JVM platform that provides Kotlin language bindings for the [`bdk`] library. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository.
+
+This project builds a .jar package for the JVM platform that provides Kotlin language bindings for the [BDK] libraries. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository.
 
 ## How to Use
-To use the Kotlin language bindings for [`bdk`] in your JVM project add the following to your gradle dependencies:
+To use the Kotlin language bindings for BDK in your JVM project add the following to your gradle dependencies:
 ```kotlin
 repositories {
     mavenCentral()
@@ -73,5 +74,5 @@ dependencies {
 }
 ```
 
-[`bdk`]: https://github.com/bitcoindevkit/bdk
+[BDK]: https://github.com/bitcoindevkit/
 [`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi

bdk-jvm/lib/README.md

@@ -4,4 +4,4 @@ The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Ko
 
 # Package org.bitcoindevkit
 
-The types coming from BDK directly. The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), and [bdk_esplora](https://crates.io/crates/bdk_esplora) crates.
+The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), [bdk_esplora](https://crates.io/crates/bdk_esplora), [bitcoin](https://crates.io/crates/bitcoin), and [miniscript](https://crates.io/crates/miniscript) crates.

bdk-python/README.md

@@ -1,15 +1,18 @@
 # bdk-python
+
 The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
 
 See the [package on PyPI](https://pypi.org/project/bdkpython/).  
 
 ## Install from PyPI
+
 Install the latest release using
 ```shell
 pip install bdkpython
 ```
 
 ## Run the tests
+
 ```shell
 pip install --requirement requirements.txt
 bash ./scripts/generate-linux.sh # here you should run the script appropriate for your platform
@@ -19,6 +22,7 @@ python -m unittest --verbose
 ```
 
 ## Build the package
+
 ```shell
 # Install dependencies
 pip install --requirement requirements.txt
@@ -31,6 +35,7 @@ python setup.py --verbose bdist_wheel
 ```
 
 ## Install locally
+
 ```shell
 pip install ./dist/bdkpython-<yourversion>.whl
 ```

bdk-python/setup.py

@@ -12,7 +12,7 @@
 
 ## Simple example
 ```python
-import bdkpython as bdk
+from bdkpython import Wallet
 ```
 """
 

bdk-swift/README.md

@@ -1,7 +1,7 @@
 # bdk-swift
 
 This project builds a Swift package that provides [Swift] language bindings for the
-[`bdk`] library. The Swift language bindings are created by the [`bdk-ffi`] project which is included as a module of this repository.
+[BDK] libraries. The Swift language bindings are created by the [`bdk-ffi`] project which is included as a module of this repository.
 
 Supported target platforms are:
 
@@ -11,7 +11,7 @@ Supported target platforms are:
 
 ## How to Use
 
-To use the Swift language bindings for [`bdk`] in your [Xcode] iOS or macOS project add
+To use the Swift language bindings for [BDK] in your [Xcode] iOS or macOS project add
 the GitHub repository https://github.com/bitcoindevkit/bdk-swift and select one of the
 release versions. You may then import and use the `BitcoinDevKit` library in your Swift
 code. For example:
@@ -43,10 +43,10 @@ If you are a maintainer of this project or want to build and publish this projec
 own GitHub repository use the following steps:
 
 1. If it doesn't already exist, create a new `release/0.MINOR` branch from the `master` branch.
-2. Add a tag `v0.MINOR.PATCH`.
-3. Run the `publish-spm` workflow on GitHub from the `bdk-swift` repo for  version `0.MINOR.PATCH`.
+2. Add a tag `vMAJOR.MINOR.PATCH`.
+3. Run the `publish-spm` workflow on GitHub from the `bdk-swift` repo for version `MAJOR.MINOR.PATCH`.
 
 [Swift]: https://developer.apple.com/swift/
 [Xcode]: https://developer.apple.com/documentation/Xcode
-[`bdk`]: https://github.com/bitcoindevkit/bdk
+[`BDK`]: https://github.com/bitcoindevkit/
 [`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi