Skip to content

Commit c292b70

Browse files
committed
feat: Update README.md
1 parent c57b7d3 commit c292b70

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -63,41 +63,36 @@ The Cocoa* aliases resolve to NS* types on macOS and UI* types on iOS, tvOS, and
6363

6464
### Basic
6565

66-
You can add CocoaAliases to an Xcode project by adding it as a package dependency.
66+
You can add `cocoa-aliases` to an Xcode project by adding it as a package dependency
6767

6868
1. From the **File** menu, select **Swift Packages › Add Package Dependency…**
69-
2. Enter [`https://github.com/capturecontext/cocoa-aliases`](https://github.com/capturecontext/cocoa-aliases) into the package repository URL text field
70-
3. Choose the products you need to link to your project.
69+
2. Enter [`"https://github.com/capturecontext/cocoa-aliases"`](https://github.com/capturecontext/cocoa-aliases) into the package repository URL text field
70+
3. Choose products you need to link to your project.
7171

7272
### Recommended
7373

74-
If you use SwiftPM for your project structure, add CocoaAliases to your package file.
74+
If you use SwiftPM for your project structure, add `cocoa-aliases` dependency to your package file.
7575

7676
```swift
7777
.package(
78-
url: "https://github.com/capturecontext/cocoa-aliases.git",
79-
.upToNextMinor(from: "3.2.2")
80-
)
81-
```
82-
83-
or via HTTPS
84-
85-
```swift
86-
.package(
87-
url: "https://github.com/capturecontext/cocoa-aliases.git",
88-
.upToNextMinor(from: "3.2.2")
78+
url: "https://github.com/capturecontext/cocoa-aliases.git",
79+
.upToNextMinor("3.3.0")
8980
)
9081
```
9182

9283
Do not forget about target dependencies:
9384

9485
```swift
9586
.product(
96-
name: "CocoaAliases",
87+
name: "CocoaAliases",
9788
package: "cocoa-aliases"
9889
)
9990
```
10091

92+
> [!NOTE]
93+
>
94+
> _The package is compatible with non-Apple platforms, however it uses conditional compilation, so **APIs are only available on Apple platforms**_
95+
10196
## License
10297

10398
This library is released under the MIT license. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)