diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cd4f946 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing Documentation + +## Setup +The XCode project is generated using `xcodgen`. + +## Making Changes Involving the Rust Layer +During development, you can simply depend on your local instance of +`mobile-sdk-rs` by editing the `Package.swift`. + +Once everything is complete, you can depend on specific commits from +`mobile-sdk-rs` as Swift's Package Manager enables it, but because of +limitations on the Android's side, you might need to publish a new version of +`mobile-sdk-rs`. + +## Release +1. Ensure the dependencies rely on published versions and not commits or + branches. +2. Ensure `SpruceIDMobileSdk.podspec`'s version is bumped and that the + dependencies' versions match the versions in `Package.swift`. +3. Push a tag in the format `x.y.z` which should match the version in the + podspec. diff --git a/README.md b/README.md index 91d1e3d..0a1b078 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,6 @@ only. We welcome feedback on the usability, architecture, and security of this implementation and are committed to a conducting a formal audit with a reputable security firm before the v1.0 release. -## Setup - -The XCode project is generated using `xcodgen`. - ## Architecture Our Mobile SDKs use shared code, with most of the logic being written once in @@ -40,4 +36,8 @@ called in native SDKs. ## Configuring Deep Links for same device flows -Click [here](./Sources/MobileSdk/ui/SameDeviceOID4VP.md) to see how to configure the same device OpenID4VP flow. \ No newline at end of file +Click [here](./Sources/MobileSdk/ui/SameDeviceOID4VP.md) to see how to configure the same device OpenID4VP flow. + +## Contributing + +See [CONTRIBUTING.md](/CONTRIBUTING.md).