diff --git a/bdk-swift/README.md b/bdk-swift/README.md index 540168e..5de436a 100644 --- a/bdk-swift/README.md +++ b/bdk-swift/README.md @@ -5,14 +5,14 @@ This project builds a Swift package that provides [Swift] language bindings for Supported target platforms are: -- MacOS, X86_64 and M1 (aarch64) +- 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 -the github repository https://github.com/bitcoindevkit/bdk-swift and select one of the +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: @@ -40,11 +40,11 @@ swift test ## 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: +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`. +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