Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: modfied README & LICENSE
  • Loading branch information
iamStephenFang committed Jul 16, 2022
commit 47a9423a0f0d9c8522b2e1a990aec918e9faacc4
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
MIT License

Copyright (c) 2022 StephenFang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Copyright (c) 2021 Related Code

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down
56 changes: 53 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## DIFFERENCES

1. Added support for 'Require Passcode'
<img src="http://image.stephenfang.me/interval.png" height="300">
<img src="http://image.stephenfang.me/newPasscode.png" height="300">

2. Added UINavigationBarAppearance support for iOS15
<img src="http://image.stephenfang.me/navBar.png" height="300">
<img src="http://image.stephenfang.me/Xnip2022-06-15_21-22-08.png" height="300">

Before / After

3. Refined localization strings

- Changed 'textTouchIDAccessReason' to 'textBiometricAccessReason'
- Added 'textBiometricAccessTip'

## OVERVIEW

PasscodeKit is a lightweight and easy-to-use, in-app Passcode implementation for iOS.
Expand All @@ -11,7 +28,7 @@ PasscodeKit is a lightweight and easy-to-use, in-app Passcode implementation for
To use PasscodeKit with [CocoaPods](https://cocoapods.org), specify in your Podfile:

```ruby
pod 'PasscodeKit'
pod 'PasscodeKit', :git => 'https://github.com/iamStephenFang/PasscodeKit.git', :branch => 'master'
```

### Manually
Expand All @@ -24,7 +41,7 @@ If you prefer not to use any of the dependency managers, you can integrate `Pass

## QUICKSTART

To activate the PasscodeKit in your codebase, you need to start it right after the app is launched. The best practice to do it in the AppDelegate `didFinishLaunchingWithOptions` method.
To activate the PasscodeKit in your codebase, you need to start it right after the app is launched. The best practice to do it in the AppDelegate `didFinishLaunchingWithOptions` method.

```swift
PasscodeKit.start()
Expand Down Expand Up @@ -52,6 +69,12 @@ PasscodeKit.removePasscode(self)

<img src="https://related.chat/passcodekit/02x.png" width="880">

The following `PasscodeKitDelegate` methods can be used to receive notifications when the password interval is changed.

```swift
func passcodeIntervalChanged()
```

## CUSTOMIZATION

The following settings are available for customizing the passcode-related user experience.
Expand Down Expand Up @@ -83,7 +106,14 @@ PasscodeKit.textEnterNewPasscode = "Enter your new passcode"
PasscodeKit.textVerifyNewPasscode = "Verify your new passcode"
PasscodeKit.textFailedPasscode = "%d Failed Passcode Attempts"
PasscodeKit.textPasscodeMismatch = "Passcodes did not match. Try again."
PasscodeKit.textTouchIDAccessReason = "Please use Touch ID to unlock the app"
PasscodeKit.textBiometricAccessReason = "Please use Touch ID to unlock the app"
PasscodeKit.textBiometricAccessTip = "Allow to use Face ID (or Touch ID) to unlock the app"
```

```swift
PasscodeKit.vefifyPasscodeImmediately = "Immediately"
PasscodeKit.vefifyPasscodeAfterMinutes = "After %.f minutes"
PasscodeKit.vefifyPasscodeAfterOneHour = "After an hour"
```

## CONFIGURATION
Expand All @@ -96,6 +126,26 @@ PasscodeKit supports both TouchID and FaceID. If you're using FaceID, be sure to

MIT License

Copyright (c) 2022 StephenFang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Copyright (c) 2021 Related Code

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down