diff --git a/Classes/BITAuthenticator.h b/Classes/BITAuthenticator.h index 3ab9c0d1bf..e5a95f5a3c 100644 --- a/Classes/BITAuthenticator.h +++ b/Classes/BITAuthenticator.h @@ -83,7 +83,8 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error); * various authentication and validation mechanisms which provide different levels of authentication. * * This does not provide DRM or copy protection in any form. Each authentication type and validation type provide - * a different level of user authorization. + * a different level of user authorization. Validation is the process of checking against the HockeyApp server if + * the provided/existing authorization is still valid. * * This module automatically disables itself when running in an App Store build by default! * @@ -107,6 +108,8 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error); * 3. on first launch of a new app version (`BITAuthenticatorValidationTypeOnFirstLaunch`) * 4. every time the app becomes active (needs internet connection) (`BITAuthenticatorValidationTypeOnAppActive`) * + * We have created a detailed guide on how to use this class: [Authenticating Users on iOS](HowTo-Authenticating-Users-on-iOS) + * */ @interface BITAuthenticator : BITHockeyBaseManager diff --git a/docs/HowTo-Authenticating-Users-on-iOS.md b/docs/HowTo-Authenticating-Users-on-iOS-template.md similarity index 100% rename from docs/HowTo-Authenticating-Users-on-iOS.md rename to docs/HowTo-Authenticating-Users-on-iOS-template.md diff --git a/docs/index.md b/docs/index.md index 7c1b0b5e5d..158b74fcb0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,6 +26,7 @@ The main SDK class is `BITHockeyManager`. It initializes all modules and provide - [Installation & Setup](Guide-Installation-Setup) - [Installation & Setup Advanced](Guide-Installation-Setup-Advanced) (Using Git submodule and Xcode sub-project) +- [Authenticating Users on iOS](HowTo-Authenticating-Users-on-iOS) - [Migration from previous SDK Versions](Guide-Migration-Kits) - [Mac Desktop Uploader](Guide-Installation-Mac-App)