From 90f08afcb6cd1cc7e3edf931fb443b47790f07cc Mon Sep 17 00:00:00 2001 From: Matt <85322+mattmassicotte@users.noreply.github.com> Date: Fri, 29 Mar 2024 08:51:44 -0400 Subject: [PATCH] Document some wrappers in the readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 8c702c4..69a39ca 100644 --- a/README.md +++ b/README.md @@ -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.