From e79076491551dfc7407324d39c06aac98447dd25 Mon Sep 17 00:00:00 2001
From: Steve Myers <steve@notmandatory.org>
Date: Tue, 22 Nov 2022 20:37:17 -0800
Subject: [PATCH] Move build-local-swift.sh into bdk-swift directory, fix
 README

---
 .gitignore                                    |  1 -
 bdk-swift/README.md                           | 21 ++++++++++++-------
 .../build-local-swift.sh                      |  7 +++++++
 3 files changed, 21 insertions(+), 8 deletions(-)
 rename build-local-swift.sh => bdk-swift/build-local-swift.sh (83%)

diff --git a/.gitignore b/.gitignore
index 6b7a9a6..6034a1e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,7 +17,6 @@ xcuserdata
 */bdk.kt
 
 # Swift related
-.DS_Store
 /.build
 /.swiftpm
 /Packages
diff --git a/bdk-swift/README.md b/bdk-swift/README.md
index e10c8b0..540168e 100644
--- a/bdk-swift/README.md
+++ b/bdk-swift/README.md
@@ -3,6 +3,12 @@
 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.
 
+Supported target platforms are:
+
+- MacOS, X86_64 and M1 (aarch64)  
+- iOS, iPhones (aarch64)  
+- iOS simulator, X86_64 and M1 (aarch64)  
+
 ## How to Use
 
 To use the Swift language bindings for [`bdk`] in your [Xcode] iOS or MacOS project add
@@ -17,7 +23,9 @@ import BitcoinDevKit
 
 ```
 
-Note: the Swift Package Manager package for `bdk-swift` is located in it's own repository (https://github.com/bitcoindevkit/bdk-swift), and that is where releases are created for it. But the code that generates the bindings is located in the https://github.com/bitcoindevkit/bdk-ffi repo in the `bdk-swift/` directory. 
+Swift Package Manager releases for `bdk-swift` are published to a separate repository (https://github.com/bitcoindevkit/bdk-swift), and that is where the releases are created for it. 
+
+The `bdk-swift/build-local-swift.sh` script can be used instead to create a version of the project for local testing.
 
 ### How to test
 
@@ -27,19 +35,18 @@ swift test
 
 ### Example Projects
 
-* TBD
+* [BdkSwiftSample](https://github.com/futurepaul/BdkSwiftSample), iOS
 
 ## How to Build and Publish
 
 If you are a maintainer of this project or want to build and publish this project to your
 own Github repository use the following steps:
 
-If you are a maintainer of this project or want to build and publish this project to your
-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.0`.
-3. Run the `publish-spm` workflow on Github from the `bdk-swift` repo for  version `0.MINOR.0`.
+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`.
 
 [Swift]: https://developer.apple.com/swift/
 [Xcode]: https://developer.apple.com/documentation/Xcode
+[`bdk`]: https://github.com/bitcoindevkit/bdk
+[`bdk-ffi`]: https://github.com/bitcoindevkit/bdk-ffi
diff --git a/build-local-swift.sh b/bdk-swift/build-local-swift.sh
similarity index 83%
rename from build-local-swift.sh
rename to bdk-swift/build-local-swift.sh
index 8ff67c2..1fdb3ff 100755
--- a/build-local-swift.sh
+++ b/bdk-swift/build-local-swift.sh
@@ -1,3 +1,10 @@
+#!/bin/bash
+# This script builds local swift-bdk Swift language bindings and corresponding bdkFFI.xcframework.
+# The results of this script can be used for locally testing your SPM package adding a local package
+# to your application pointing at the bdk-swift directory.
+#
+# Run the script from the repo root directory, ie: ./bdk-swift/build-local-swift.sh
+
 rustup install nightly-x86_64-apple-darwin
 rustup component add rust-src --toolchain nightly-x86_64-apple-darwin
 rustup target add aarch64-apple-ios x86_64-apple-ios