Skip to content

Commit 4da5a27

Browse files
committed
Applying template to README
1 parent 9473d39 commit 4da5a27

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,19 @@
44

55
This tool allows comparing 2 versions of a swift (sdk) project and lists all changes in a human readable way.
66

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
815

916
## Usage
1017

1118
### From Project to Output
19+
This method requires an iOS 17.5 Simulator to be installed
1220

1321
```
1422
swift run public-api-diff
@@ -112,12 +120,13 @@ OPTIONS:
112120
```
113121
</details>
114122

115-
## How to create a release build
123+
## Release Build
124+
### Create
116125
```
117126
swift build --configuration release
118127
```
119128

120-
## Run release build
129+
### Run
121130
```
122131
./public-api-diff
123132
project
@@ -136,11 +145,17 @@ swift build --configuration release
136145
--old "old/path/to/project.framework"
137146
```
138147

139-
# Alternatives
148+
## Alternatives
140149
- **swift-api-digester**
141150
- `xcrun swift-api-digester -dump-sdk`
142151
- `xcrun swift-api-digester -diagnose-sdk`
143152

144-
# Inspiration
153+
## Inspiration
145154
- https://github.com/sdidla/Hatch/blob/main/Sources/Hatch/SymbolParser.swift
146155
- 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

Comments
 (0)