Updated the readme

README.md

@@ -1,2 +1,54 @@
-#SwiftPasscodeLock
-An iOS passcode lock with Touch ID authentication written in Swift.
+# PasscodeLock
+A Swift implementation of passcode lock for iOS with TouchID authentication.
+
+<img src="https://raw.githubusercontent.com/yankodimitrov/SwiftPasscodeLock/master/passcode-lock.gif" height="386">
+
+## Installation
+PasscodeLock requires Swift 2.0 and XCode 7 beta 6
+
+#### Carthage
+
+Add the following line to your [Cartfile](https://github.com/carthage/carthage)
+```swift
+github "yankodimitrov/SwiftPasscodeLock"
+```
+## Usage
+
+1. Create an implementation of the `PasscodeRepositoryType` protocol.
+
+2. Create an implementation of the `PasscodeLockConfigurationType` protocol and set your preferred passcode lock configuration options. If you set the `maximumInccorectPasscodeAttempts` to a number greather than zero when the user reaches that number of incorrect passcode attempts a notification with name `PasscodeLockIncorrectPasscodeNotification` will be posted on the default `NSNotificationCenter`. 
+
+3. Create an instance of the `PasscodeLockPresenter` class. Next inside your `UIApplicationDelegate` implementation call it to present the passcode in `didFinishLaunchingWithOptions` and `applicationDidEnterBackground` methods. The passcode lock will be presented only if your user has set a passcode.
+
+4. Allow your users to set a passcode by presenting the `PasscodeLockViewController` in `.SetPasscode` state:
+```swift
+let configuration = ... // your implementation of the PasscodeLockConfigurationType protocol
+
+let passcodeVC = PasscodeLockViewController(state: .SetPasscode, configuration: configuration)
+
+presentViewController(passcodeVC, animated: true, completion: nil)
+```
+
+You can present the `PasscodeLockViewController` in one of the four initial states using the `LockState` enumeration options: `.EnterPasscode`, `.SetPasscode`, `.ChangePasscode`, `.RemovePasscode`.
+
+Also you can set the initial passcode lock state to your own implementation of the `PasscodeLockStateType` protocol.
+
+## Customization
+
+#### Custom Design
+
+The PasscodeLock will look for `PasscodeLockView.xib` inside your app bundle and if it can't find it will load its default one, so if you want to have a custom design create a new `xib` with the name `PasscodeLockView` and set its owner to an instance of `PasscodeLockViewController` class.
+
+Then connect the `view` outlet to the view of your `xib` file and make sure to conenct the remaining `IBOutlet`s and `IBAction`s.
+
+PasscodeLock comes with two view components: `PasscodeSignPlaceholderView` and `PasscodeSignButton` that you can use to create your own custom designs. Both classes are `@IBDesignable` and `@IBInspectable`, so you can see their appearance and change their properties right inside the interface builder:
+
+<img src="https://raw.githubusercontent.com/yankodimitrov/SwiftPasscodeLock/master/passcode-view.png" height="270">
+
+#### Localization
+
+Take a look at `PasscodeLock/en.lproj/PasscodeLock.strings` for the localization keys. Here again the PasscodeLock will look for the `PasscodeLock.strings` file inside your app bundle and if it can't find it will use the default localization file.
+
+## Demo App
+
+The demo app comes with a simple implementation of the `PasscodeRepositoryType` protocol that is using the **NSUserDefaults** to store an retrieve the passcode. In your real applications you will probably want to use the **Keychain API**. Keep in mind that the **Keychain** records will not be removed when your user deletes your app.