frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Swift readme for 0.26.0 release

Browse Source
This commit is contained in:
thunderbiscuit 2023-01-09 21:36:19 -05:00
parent 6555170d28
commit d77f5b84c3
No known key found for this signature in database
GPG Key ID: 88253696EB836462
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
bdk-swift/README.md
View File

@ -5,14 +5,14 @@ This project builds a Swift package that provides [Swift] language bindings for
Supported target platforms are: Supported target platforms are:
- MacOS, X86_64 and M1 (aarch64) - macOS, X86_64 and M1 (aarch64)
- iOS, iPhones (aarch64) - iOS, iPhones (aarch64)
- iOS simulator, X86_64 and M1 (aarch64) - iOS simulator, X86_64 and M1 (aarch64)
## How to Use ## 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 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 release versions. You may then import and use the `BitcoinDevKit` library in your Swift
code. For example: code. For example:
@ -40,11 +40,11 @@ swift test
## How to Build and Publish ## How to Build and Publish
If you are a maintainer of this project or want to build and publish this project to your 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: 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. 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`. 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`. 3. Run the `publish-spm` workflow on GitHub from the `bdk-swift` repo for version `0.MINOR.PATCH`.
[Swift]: https://developer.apple.com/swift/ [Swift]: https://developer.apple.com/swift/
[Xcode]: https://developer.apple.com/documentation/Xcode [Xcode]: https://developer.apple.com/documentation/Xcode