diff --git a/README.md b/README.md index 7855f12..4274575 100755 --- a/README.md +++ b/README.md @@ -1,23 +1,44 @@ -SmileToUnlock ![Pod status](https://cocoapod-badges.herokuapp.com/v/SmileToUnlock/badge.png) ---- +# SmileToUnlock + +[![Cocoapods](https://img.shields.io/cocoapods/v/SmileToUnlock)](https://cocoapods.org/pods/SmileToUnlock) [![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager) + Make your users smile before opening the app :)

Demo gif
Gif with the demonstration

-Installation ---- +## Installation + +### Cocoapods The most preferable way to use this library is cocoapods. Add the following line to your `Podfile`: ```sh pod 'SmileToUnlock' ``` and run `pod install` in your terminal. -Alternatively, you can manually add the files in the `SmileToUnlock` directory to your project. - -Usage --- +### Swift Package Manager +Add the following as a dependency to your `Package.swift: +```swift +.package(url: "https://github.com/rsrbk/SmileToUnlock.git", from: "1.0.3") +``` +and then specify `"SmileToUnlock"` as a dependency of the Target in which you wish to use SmileToUnlock. Here's an example: +```swift + let package = Package( + name: "Example", + dependencies: [ + .package(url: "https://github.com/rsrbk/SmileToUnlock.git", from: "1.0.3") + ], + targets: [ + .target(name: "Example", dependencies: ["SmileToUnlock"]) + ] + ) + ``` + +### Manually +Add the files in the `SmileToUnlock` directory to your project. + +## Usage First of all, you have to add NSCameraUsageDescription to you Info.plist with a brief explanation. Then you need to check if a user's device has the face tracking support: @@ -72,25 +93,21 @@ public enum SmileToUnlockBackground { Blue Red Purple

-Feature requests --- +## Feature requests If you wish to contribute, look at this topics: - Improving the face itself (maybe some 3D model) - Adding additional emotions (like eye blinking) - Improving the UI of the screen -Follow me on twitter --- +## Follow me on twitter I promise it's gonna be more interesting stuff there! [@rsrbk123](https://twitter.com/rsrbk123) -Check out my other libraries --- +## Check out my other libraries [SRCountdownTimer](https://github.com/rsrbk/SRCountdownTimer) - a simple circle countdown with a configurable timer.
[SRAttractionsMap](https://github.com/rsrbk/SRAttractionsMap) - the map with attractions on which you can click and see the full description. -License --- +## License MIT License Copyright (c) 2017 Ruslan Serebriakov diff --git a/SmileToUnlock.podspec b/SmileToUnlock.podspec index 0629285..cf692f1 100644 --- a/SmileToUnlock.podspec +++ b/SmileToUnlock.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'SmileToUnlock' - s.version = '1.0.1' + s.version = '1.0.3' s.summary = 'Make your users smile before opening the app :)' s.description = <<-DESC