You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-5Lines changed: 20 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,19 @@
4
4
5
5
This tool allows comparing 2 versions of a swift (sdk) project and lists all changes in a human readable way.
6
6
7
-
It makes use of `.swiftinterface` files that get produced during the archiving of a swift project and parses them using [`swift-syntax`](https://github.com/swiftlang/swift-syntax).
7
+
It makes use of `.swiftinterface` files that get produced during the archiving of a swift project and parses them using [`swift-syntax`](https://github.com/swiftlang/swift-syntax).
8
+
9
+
## Contributing
10
+
We strongly encourage you to contribute to our repository. Find out more in our [contribution guidelines](https://github.com/Adyen/.github/blob/master/CONTRIBUTING.md)
11
+
12
+
## Requirements
13
+
-**Xcode** >= 16.0 (incl. Xcode command line tools)
14
+
-**Swift** >= 5.9
8
15
9
16
## Usage
10
17
11
18
### From Project to Output
19
+
This method requires an iOS 17.5 Simulator to be installed
12
20
13
21
```
14
22
swift run public-api-diff
@@ -112,12 +120,13 @@ OPTIONS:
112
120
```
113
121
</details>
114
122
115
-
## How to create a release build
123
+
## Release Build
124
+
### Create
116
125
```
117
126
swift build --configuration release
118
127
```
119
128
120
-
## Run release build
129
+
###Run
121
130
```
122
131
./public-api-diff
123
132
project
@@ -136,11 +145,17 @@ swift build --configuration release
- For parsing swift files using [swift-syntax](https://github.com/swiftlang/swift-syntax)'s [`SyntaxVisitor`](https://github.com/swiftlang/swift-syntax/blob/main/Sources/SwiftSyntax/generated/SyntaxVisitor.swift)
156
+
157
+
## Support
158
+
If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue.
159
+
160
+
## License
161
+
MIT license. For more information, see the LICENSE file.
0 commit comments