Updated the README file to include instructions for obtaining the original URL.#9
Updated the README file to include instructions for obtaining the original URL.#9rajpootathar wants to merge 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
Updates the README documentation to clarify how to obtain the original URL when handling Universal Links in iOS applications. The changes emphasize that the SDK provides access to the original URL that short links point to, along with host and path information.
- Enhanced documentation to explain the three key properties provided by the SDK: host, path, and url
- Updated code examples in both SwiftUI and Storyboard sections to demonstrate accessing the original URL
- Improved clarity around the purpose of URL processing in Universal Link handling
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ### SwiftUI Project | ||
|
|
||
| For SwiftUI apps, use the `onOpenURL` modifier at the entry point of your app to process incoming URLs and navigate to the appropriate views. Below is an example implementation in SwiftUI. | ||
| For SwiftUI apps, use the `onOpenURL` modifier at the entry point of your app to process incoming URLs and retrieve the original URL. |
There was a problem hiding this comment.
The description is incomplete. It mentions retrieving the original URL but doesn't explain what happens after retrieval (e.g., navigation to appropriate views). Consider adding 'and navigate to the appropriate views' to maintain completeness.
| For SwiftUI apps, use the `onOpenURL` modifier at the entry point of your app to process incoming URLs and retrieve the original URL. | |
| For SwiftUI apps, use the `onOpenURL` modifier at the entry point of your app to process incoming URLs, retrieve the original URL, and navigate to the appropriate view based on the URL. |
| ### Storyboard Project | ||
|
|
||
| For Storyboard apps, implement the `scene(_:continue:)` method in your `SceneDelegate` to handle Universal Links. Below is an example implementation in Storyboard. | ||
| For Storyboard-based apps, you can handle incoming Short.io links (Universal Links) in your SceneDelegate. Implement the scene(_:continue:) method to capture the URL and pass it to the SDK for processing. |
There was a problem hiding this comment.
The method name formatting is inconsistent. Use backticks around scene(_:continue:) to match the formatting style used elsewhere in the documentation.
| For Storyboard-based apps, you can handle incoming Short.io links (Universal Links) in your SceneDelegate. Implement the scene(_:continue:) method to capture the URL and pass it to the SDK for processing. | |
| For Storyboard-based apps, you can handle incoming Short.io links (Universal Links) in your SceneDelegate. Implement the `scene(_:continue:)` method to capture the URL and pass it to the SDK for processing. |
No description provided.