From b385cccc202d0e76c3f136520bb0e06775d722fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9otix?= Date: Mon, 27 Nov 2017 14:04:37 +0100 Subject: [PATCH] Fix links to Readme in Quick Start Guide --- Docs/QuickStartGuide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Docs/QuickStartGuide.md b/Docs/QuickStartGuide.md index f2ba52b..50554ab 100644 --- a/Docs/QuickStartGuide.md +++ b/Docs/QuickStartGuide.md @@ -2,7 +2,7 @@ This guide will walk you through creating a minimal Turbolinks for iOS application. -We’ll use the demo app’s bundled server in our examples, which runs at `http://localhost:9292/`, but you can adjust the URL and hostname below to point to your own application. See [Running the Demo](README.md#running-the-demo) for instructions on starting the demo server. +We’ll use the demo app’s bundled server in our examples, which runs at `http://localhost:9292/`, but you can adjust the URL and hostname below to point to your own application. See [Running the Demo](../README.md#running-the-demo) for instructions on starting the demo server. Note that for the sake of brevity, these examples use a UINavigationController and implement everything inside the AppDelegate. In a real application, you may not want to use a navigation controller, and you should consider factoring these responsibilities out of the AppDelegate and into separate classes. @@ -28,7 +28,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate { ## 2. Configure your project for Turbolinks -**Add Turbolinks to your project.** Install the Turbolinks framework using Carthage, CocoaPods, or manually by building `Turbolinks.framework` and linking it to your Xcode project. See [Installation](README.md#installation) for more instructions. +**Add Turbolinks to your project.** Install the Turbolinks framework using Carthage, CocoaPods, or manually by building `Turbolinks.framework` and linking it to your Xcode project. See [Installation](../README.md#installation) for more instructions. **Configure NSAppTransportSecurity for the demo server.** By default, iOS versions 9 and later restrict access to unencrypted HTTP connections. In order for your application to connect to the demo server, you must configure it to allow insecure HTTP requests to `localhost`. @@ -44,7 +44,7 @@ See [Apple’s property list documentation](https://developer.apple.com/library/ ## 3. Set up a Turbolinks Session and perform an initial visit -A Turbolinks Session manages a WKWebView instance and moves it between Visitable view controllers when you navigate. Your application is responsible for displaying a Visitable view controller, giving it a URL, and telling the Session to visit it. See [Understanding Turbolinks Concepts](README.md#understanding-turbolinks-concepts) for details. +A Turbolinks Session manages a WKWebView instance and moves it between Visitable view controllers when you navigate. Your application is responsible for displaying a Visitable view controller, giving it a URL, and telling the Session to visit it. See [Understanding Turbolinks Concepts](../README.md#understanding-turbolinks-concepts) for details. In your AppDelegate, create and retain a Session. Then, create a VisitableViewController with the demo server’s URL, and push it onto the navigation stack. Finally, call `session.visit()` with your view controller to perform the visit. @@ -81,7 +81,7 @@ To handle link taps and initiate a Turbolinks visit, you must configure the Sess ## 4. Configure the Session’s delegate -The Session notifies its delegate by proposing a visit whenever you tap a link. It also notifies its delegate when a visit request fails. The Session’s delegate is responsible for handling these events and deciding how to proceed. See [Creating a Session](README.md#creating-a-session) for details. +The Session notifies its delegate by proposing a visit whenever you tap a link. It also notifies its delegate when a visit request fails. The Session’s delegate is responsible for handling these events and deciding how to proceed. See [Creating a Session](../README.md#creating-a-session) for details. First, assign the Session’s `delegate` property. For demonstration purposes, we’ll make AppDelegate the Session’s delegate. @@ -118,4 +118,4 @@ We handle a proposed visit in the same way as the initial visit: by creating a V ## 5. Read the documentation -A real application will want to customize the view controller, respond to different visit actions, and gracefully handle errors. See [Building Your Turbolinks Application](README.md#building-your-turbolinks-application) for detailed instructions. +A real application will want to customize the view controller, respond to different visit actions, and gracefully handle errors. See [Building Your Turbolinks Application](../README.md#building-your-turbolinks-application) for detailed instructions.