Skip to content

Commit

Permalink
Document some wrappers in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mattmassicotte committed Mar 29, 2024
1 parent 57fe857 commit 90f08af
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ public protocol NSUIViewControllerRepresentable: UIViewControllerRepresentable {
}
```

## Cross-Platform Wrappers

There are cases where it is necessary to provide cross-platform wrappers around functions, acessors, or initializers.

```swift
Color(nsuiColor: NSUIColor)
Image(nsuiImage: NSUIImage)
```

## Conventions
NSUI is not a multi-platform framework to replace both UIKit and AppKit. As stated above, `NSUI` takes the stance that
the API from `UIKit` is the first-class citizen. However, in some cases, both AppKit and UIKit are very close to each other.
Expand Down

0 comments on commit 90f08af

Please sign in to comment.