-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
22ac85d
commit 93d35e8
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,45 @@ | ||
# SafariView | ||
|
||
[![MIT License](https://img.shields.io/github/license/vsanthanam/SafariView)](https://github.com/vsanthanam/SafariView/blob/main/LICENSE) | ||
[![Package Releases](https://img.shields.io/github/v/release/vsanthanam/SafariView)](https://github.com/vsanthanam/SafariView/releases) | ||
[![Build Results](https://img.shields.io/github/workflow/status/vsanthanam/SafariView/spm-build-test)](https://img.shields.io/github/workflow/status/vsanthanam/SafariView/spm-build-test) | ||
[![Swift Version](https://img.shields.io/badge/swift-5.6-critical)](https://swift.org) | ||
[![Supported Platforms](https://img.shields.io/badge/platform-iOS%2013%20%7C%20macOS%2010.15%20%7C%20tvOS%2013%20%7C%20watchOS%206-lightgrey)](https://developer.apple.com) | ||
|
||
A SwiftUI wrapper around `SFSafariViewControllerDelegate` | ||
|
||
## Installation | ||
|
||
SafariView currently distributed exclusively through the [Swift Package Manager](https://www.swift.org/package-manager/). | ||
|
||
To add SafariView as a dependency to an existing Swift package, add the following line of code to the `dependencies` parameter of your `Package.swift` file: | ||
|
||
```swift | ||
dependencies: [ | ||
.package(url: "https://github.com/vsanthanam/SafariView.git", .upToNextMajor(from: "1.0.0")) | ||
] | ||
``` | ||
|
||
To add SafariView as a dependency to an Xcode Project: | ||
|
||
- Choose `File` → `Add Packages...` | ||
- Enter package URL `https://github.com/vsanthanam/SafariView.git` and select your release and of choice. | ||
|
||
Other distribution mechanisms like CocoaPods or Carthage may be added in the future. | ||
|
||
## Usage & Documentation | ||
|
||
SafariView's documentation is built with [DocC](https://developer.apple.com/documentation/docc) and included in the repository as a DocC archive. The latest version is hosted on [GitHub Pages](https://pages.github.com) and is available [here](https://reachability.tools/docs/documentation/SafariView). | ||
|
||
[![Documentation](Images/Documentation.svg)](https://reachability.tools/docs/documentation/SafariView) | ||
|
||
Additional installation instructions are available on the [Swift Package Index](https://swiftpackageindex.com/vsanthanam/SafariView) | ||
|
||
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FSafariView%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/vsanthanam/SafariView) | ||
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FSafariView%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/vsanthanam/SafariView) | ||
|
||
Explore [the documentation](https://vsanthanam.github.io/docs/documentation/SafariView) for more details. | ||
|
||
## License | ||
|
||
**SafariView** is available under the MIT license. See the LICENSE file for more information. |