Skip to content

Commit b469261

Browse files
authored
Update README.md
1 parent 41e8b8b commit b469261

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

+20-8
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,26 @@ We strongly encourage you to contribute to our repository. Find out more in our
1919
## Usage
2020

2121
### From Project to Output
22-
This method requires an iOS 17.5 Simulator to be installed
2322

24-
```
23+
```bash
24+
# Build using the iOS sdk
25+
# This method requires an iOS Simulator to be installed
2526
swift run public-api-diff
2627
project
2728
--platform iOS
2829
--new "develop~https://github.com/Adyen/adyen-ios.git"
2930
--old "5.12.0~https://github.com/Adyen/adyen-ios.git"
3031
```
3132

33+
```bash
34+
# Build using the macOS sdk
35+
swift run public-api-diff
36+
project
37+
--platform macOS
38+
--new "main~https://github.com/Adyen/adyen-swift-public-api-diff"
39+
--old "0.4.0~https://github.com/Adyen/adyen-swift-public-api-diff"
40+
```
41+
3242
<details><summary><b>--help:</b></summary>
3343

3444
```
@@ -54,7 +64,7 @@ OPTIONS:
5464

5565
### From `.swiftinterface` to Output
5666

57-
```
67+
```bash
5868
swift run public-api-diff
5969
swift-interface
6070
--new "new/path/to/project.swiftinterface"
@@ -89,7 +99,7 @@ OPTIONS:
8999

90100
### From `.framework` to Output
91101

92-
```
102+
```bash
93103
swift run public-api-diff
94104
framework
95105
--target-name "TargetName"
@@ -127,22 +137,24 @@ OPTIONS:
127137

128138
## Release Build
129139
### Create
130-
```
140+
```bash
131141
swift build --configuration release
132142
```
133143

134144
### Run
135-
```
145+
```bash
136146
./public-api-diff
137147
project
138148
--new "develop~https://github.com/Adyen/adyen-ios.git"
139149
--old "5.12.0~https://github.com/Adyen/adyen-ios.git"
140-
150+
```
151+
```bash
141152
./public-api-diff
142153
swift-interface
143154
--new "new/path/to/project.swiftinterface"
144155
--old "old/path/to/project.swiftinterface"
145-
156+
```
157+
```bash
146158
./public-api-diff
147159
framework
148160
--target-name "TargetName"

0 commit comments

Comments
 (0)