Updated README and CHANGELOG

Author: rolandleth

CHANGELOG.md

@@ -1,7 +1,6 @@
 # 3.8.9
-* Added support for iOS App Extensions:
-	* Now, if you add a macro to project settings (`LTH_APP_EXTENSIONS`), `LTHPasscodeViewController` doesn’t crash under an extension target.
-	* Also, with a new method, you can provide a view in which the lock is going to be presented and centered in.
+* Added support for iOS App Extensions: defining `LTH_IS_APP_EXTENSION` for an extension target will fix `LTHPasscodeViewController` crashing.
+* Added new method: `- (void)showLockScreenOver:(UIView *)superview withAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString *)logoutTitle`. Used to provide a view in which the lock is going to be presented, sized to and centered in.
 
 # 3.8.8
 * Fixed translations.

LTHPasscodeViewController/LTHPasscodeViewController.h

@@ -312,33 +312,33 @@
  @param hasLogout   Set to @c YES for a navBar with a Logout button, set to @c NO for no navBar.
  @param logoutTitle The title of the Logout button.
  */
-- (void)showLockScreenWithAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString*)logoutTitle;
+- (void)showLockScreenWithAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString *)logoutTitle;
 /**
- @brief				Used for displaying the lock. The passcode view is added directly on the keyWindow.
- @param superview   The superview where is to be presented, used to measure the center of the view.
+ @brief				Used for displaying the lock over a view; the lock will have the same size and center as the @c superview.
+ @param superview   The @c view where the lock will be added to and presented over.
  @param hasLogout   Set to @c YES for a navBar with a Logout button, set to @c NO for no navBar.
  @param logoutTitle The title of the Logout button.
  */
-- (void)showLockScreenOver:(UIView *)superview withAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString*)logoutTitle;
+- (void)showLockScreenOver:(UIView *)superview withAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString *)logoutTitle;
 /**
  @brief				   Used for enabling the passcode.
  @details              The back bar button is hidden by default. Set @c hidesBackButton to @c NO if you want it to be visible.
  @param	viewController The view controller where the passcode view controller will be displayed.
- @param asModal        Set to @c YES to present as a modal, or to @c NO to push on the current nav stack.
+ @param isModal        Set to @c YES to present as a modal, or to @c NO to push on the current nav stack.
  */
 - (void)showForEnablingPasscodeInViewController:(UIViewController *)viewController asModal:(BOOL)isModal;
 /**
  @brief				   Used for changing the passcode.
  @details              The back bar button is hidden by default. Set @c hidesBackButton to @c NO if you want it to be visible.
  @param	viewController The view controller where the passcode view controller will be displayed.
- @param asModal        Set to @c YES to present as a modal, or to @c NO to push on the current nav stack.
+ @param isModal        Set to @c YES to present as a modal, or to @c NO to push on the current nav stack.
  */
 - (void)showForChangingPasscodeInViewController:(UIViewController *)viewController asModal:(BOOL)isModal;
 /**
  @brief				   Used for disabling the passcode.
  @details              The back bar button is hidden by default. Set @c hidesBackButton to @c NO if you want it to be visible.
  @param	viewController The view controller where the passcode view controller will be displayed.
- @param asModal        Set to @c YES to present as a modal, or to @c NO to push on the current nav stack.
+ @param isModal        Set to @c YES to present as a modal, or to @c NO to push on the current nav stack.
  */
 - (void)showForDisablingPasscodeInViewController:(UIViewController *)viewController asModal:(BOOL)isModal;
 /**

LTHPasscodeViewController/LTHPasscodeViewController.m

@@ -49,7 +49,7 @@
  Any help would be greatly appreciated.
  */
 
-#if defined(LTH_APP_EXTENSIONS)
+#ifdef LTH_IS_APP_EXTENSION
 #define LTHMainWindow [UIApplication sharedApplication].keyWindow
 #else
 #define LTHMainWindow [UIApplication sharedApplication].windows[0]

README.md

@@ -2,7 +2,12 @@
 Simple to use iOS 7 style Passcode - the one you get in Settings when changing your passcode.
 
 # How to use
-Drag the contents of `LTHPasscodeViewController` to your project, or add `pod 'LTHPasscodeViewController'` to your podspec file.
+Drag the contents of `LTHPasscodeViewController` to your project, or add `pod 'LTHPasscodeViewController'` to your Podfile (preffered).
+
+If your app uses extensions, `LTH_IS_APP_EXTENSION` needs to be defined:
+
+* either in each target's `Prefix.pch` file, if there is one, via `#define LTH_IS_APP_EXTENSION`
+* or in each target's build settings, down to `Preprocessor Macros`, double click each of your schemes, click on the `+` on the popup that appears and add `LTH_IS_APP_EXTENSION`
 
 Example, called in `application:didFinishLaunchingWithOptions`:
 
@@ -32,7 +37,7 @@ if ([LTHPasscodeViewController doesPasscodeExist]) {
 - (void)deletePasscode;
 - (void)savePasscode:(NSString *)passcode;
 - (NSString *)passcode;
-// All of them fall back on the Keychain if they are not implemented, even if [LTHPasscodeViewController useKeychain:NO] was called, for flexibility over what and where you save. 
+// All of them fall back on the Keychain if they are not implemented, even if [LTHPasscodeViewController useKeychain:NO] was called, for flexibility over what and where you save.
 // Do you only want to save the passcode in a different location and leave everything else in the Keychain? Call [LTHPasscodeViewController useKeychain:NO], but only implement -savePasscode:
 ```
 
@@ -48,30 +53,39 @@ if ([LTHPasscodeViewController doesPasscodeExist]) {
 - (void)showForChangingPasscodeInViewController:(UIViewController *)viewController asModal:(BOOL)isModal;
 ```
 
-* Show the lock screen:
+* Show the lock screen over the window:
 
 ```objc
 - (void)showLockScreenWithAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString*)logoutTitle;
 
 // Example:
 [[LTHPasscodeViewController sharedUser] showLockscreenWithAnimation:YES withLogout:NO andLogoutTitle:nil];
-// Displayed with a slide up animation, which, combined with 
+// Displayed with a slide up animation, which, combined with
 // the keyboard sliding down animation, creates an "unlocking" impression.
 ```
 
-* entering foreground and resigning is handled from within the class. 
+* Show the lock screen over a specific view. Works like the above method, but the size and center will be of the passed in view:
+
+```objc
+- (void)showLockScreenOver:(UIView *)superview withAnimation:(BOOL)animated withLogout:(BOOL)hasLogout andLogoutTitle:(NSString *)logoutTitle;
+
+// Example:
+[[LTHPasscodeViewController sharedUser] showLockscreenOver:popover withAnimation:YES withLogout:NO andLogoutTitle:nil];
+```
+
+* entering foreground and resigning is handled from within the class.
 
 
 Makes use of [SFHFKeyChainUtils](https://github.com/ldandersen/scifihifi-iphone) to save the passcode in the Keychain. I know he dropped support for it, but I updated it for ARC 2 years ago ([with help](http://stackoverflow.com/questions/7663443/sfhfkeychainutils-ios-keychain-arc-compatible)) and I kept using it since. The 'new' version isn't updated to ARC anyway, so I saw no reason to switch to it, or to any other library.
 
-Feel free to [contact me](mailto:[email protected]), or open an issue if anything is unclear, bugged, or can be improved. 
+Feel free to [contact me](mailto:[email protected]), or open an issue if anything is unclear, bugged, or can be improved.
 
-![Screenshot](http://rolandleth.com/assets/ios7-style-passcode/screenshot.png)   ![Screenshot](http://rolandleth.com/assets/ios7-style-passcode/change-passcode-screenshot.png)
+![Screenshot](https://rolandleth.com/images/ios7-style-passcode/screenshot.png)   ![Screenshot](https://rolandleth.com/images/ios7-style-passcode/change-passcode-screenshot.png)
 
 # Apps using this control
 [Expenses Planner](https://itunes.apple.com/us/app/expenses-planner-reminders/id669431471?mt=8), [DigitalOcean Manager](https://itunes.apple.com/us/app/digitalocean-manager/id633128302?mt=8), [LovelyHeroku](https://itunes.apple.com/us/app/lovelyheroku/id706287663?mt=8&uo=4), [Flow Web Browser](https://itunes.apple.com/us/app/flow-web-browser-downloader/id705536564?mt=8), [Balance - Checkbook App](https://itunes.apple.com/US/app/id854362248), [QIF Reader](https://itunes.apple.com/us/app/qif-reader/id374178932?mt=8), [Zee - Personal Finance](https://itunes.apple.com/us/app/zee-personal-finance/id422694086?mt=8), [EZDiary](https://itunes.apple.com/us/app/ezdiary-my-diary/id1128083826?ls=1&mt=8), [MEGA](https://itunes.apple.com/us/app/mega/id706857885?mt=8).
 
-If you're using this control, I'd love hearing from you!  
+If you're using this control, I'd love hearing from you!
 
 # License
 Licensed under MIT. If you'd like (or need) a license without attribution, don't hesitate to [contact me](mailto:[email protected]).