Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,26 @@ We strongly encourage you to contribute to our repository. Find out more in our
## Usage

### From Project to Output
This method requires an iOS 17.5 Simulator to be installed

```
```bash
# Build using the iOS sdk
# This method requires an iOS Simulator to be installed
swift run public-api-diff
project
--platform iOS
--new "develop~https://github.com/Adyen/adyen-ios.git"
--old "5.12.0~https://github.com/Adyen/adyen-ios.git"
```

```bash
# Build using the macOS sdk
swift run public-api-diff
project
--platform macOS
--new "main~https://github.com/Adyen/adyen-swift-public-api-diff"
--old "0.4.0~https://github.com/Adyen/adyen-swift-public-api-diff"
```

<details><summary><b>--help:</b></summary>

```
Expand All @@ -54,7 +64,7 @@ OPTIONS:

### From `.swiftinterface` to Output

```
```bash
swift run public-api-diff
swift-interface
--new "new/path/to/project.swiftinterface"
Expand Down Expand Up @@ -89,7 +99,7 @@ OPTIONS:

### From `.framework` to Output

```
```bash
swift run public-api-diff
framework
--target-name "TargetName"
Expand Down Expand Up @@ -127,22 +137,24 @@ OPTIONS:

## Release Build
### Create
```
```bash
swift build --configuration release
```

### Run
```
```bash
./public-api-diff
project
--new "develop~https://github.com/Adyen/adyen-ios.git"
--old "5.12.0~https://github.com/Adyen/adyen-ios.git"

```
```bash
./public-api-diff
swift-interface
--new "new/path/to/project.swiftinterface"
--old "old/path/to/project.swiftinterface"

```
```bash
./public-api-diff
framework
--target-name "TargetName"
Expand Down
Loading