Skip to content

Latest commit

 

History

History
20 lines (11 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

20 lines (11 loc) · 1.29 KB
Raw

💡Contribution Guide

This repository is used to publish a Swift package as well as a CocoaPod providing Swift bindings to the Breez SDK's underlying Rust implementation. These Swift bindings are generated using UniFFi.

Changing the Breez SDK

Any changes to the Breez SDK and its Swift bindings, must be made via the main breez/breez-sdk repository.

Swift Package Configuration

The Swift package configuration maintained in the main breez/breez-sdk repository and automatically copied to this repository by the release CI workflow. Therefore, any changes to the Swift Package configuration must be made in the main repository.

CocoaPods Configuration

The CocoaPod configuration is maintained in this repository and changes to it can be made in this repository directly.

The CocoaPod configuration consists of two parts:

  • breez_sdkFFI.podspec: A CocoaPod publishing just the Breez SDK's low-level Rust interface. This is not meant to be consumed directly.
  • BreezSDK.podspec: The main CocoaPod which depends on breez_sdkFFI and publishes high-level Swift bindings to the underlying Rust interface.