Feature/readme

Cartfile.resolved

@@ -1 +1 @@
-github "hyperoslo/Hue" "9588169ba4201e8a1038a3d2c1750843bf90d7e0"
+github "hyperoslo/Hue" "f82ffc7dd55d093d3acc6ce5b3d36ca259091fdd"

Demos/DemoLightbox/Podfile

@@ -3,7 +3,5 @@ platform :ios, '8.0'
 use_frameworks!
 inhibit_all_warnings!
 
-target 'DemoLightbox' do
-  pod 'Lightbox', path: '../../'
-  pod 'Hue', git: 'https://github.com/hyperoslo/Hue'
-end
+pod 'Lightbox', path: '../../'
+target 'DemoLightbox'

Demos/DemoLightbox/Podfile.lock

@@ -6,25 +6,17 @@ PODS:
   - Sugar (3.0.0)
 
 DEPENDENCIES:
-  - Hue (from `https://github.com/hyperoslo/Hue`)
   - Lightbox (from `../../`)
 
 EXTERNAL SOURCES:
-  Hue:
-    :git: https://github.com/hyperoslo/Hue
   Lightbox:
     :path: "../../"
 
-CHECKOUT OPTIONS:
-  Hue:
-    :commit: ef39c988eb6c1606454359c808e5373edb257c57
-    :git: https://github.com/hyperoslo/Hue
-
 SPEC CHECKSUMS:
-  Hue: ab7efb15270e0bc764f2f468aa6f3f2728d52f2b
+  Hue: 354caec055fdc9d38b5ef33ca2e7224721843baf
   Lightbox: e4523e8cf3261cbc833d0e76ae4dae774731d115
   Sugar: 079e1375b76c8f0693474417836ef098f507ac50
 
-PODFILE CHECKSUM: 2f4174011e05bafa19e471a87fbcc5ecded249bf
+PODFILE CHECKSUM: cd88b68c201e5c39cef62070056649eaee91c71b
 
 COCOAPODS: 1.1.1

README.md

@@ -1,14 +1,160 @@
 # Lightbox
 
-[![CI Status](http://img.shields.io/travis/hyperoslo/Lightbox.svg?style=flat)](https://travis-ci.org/hyperoslo/Lightbox)
 [![Version](https://img.shields.io/cocoapods/v/Lightbox.svg?style=flat)](http://cocoadocs.org/docsets/Lightbox)
+[![CI Status](http://img.shields.io/travis/hyperoslo/Lightbox.svg?style=flat)](https://travis-ci.org/hyperoslo/Lightbox)
+[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 [![License](https://img.shields.io/cocoapods/l/Lightbox.svg?style=flat)](http://cocoadocs.org/docsets/Lightbox)
 [![Platform](https://img.shields.io/cocoapods/p/Lightbox.svg?style=flat)](http://cocoadocs.org/docsets/Lightbox)
+![Swift](https://img.shields.io/badge/%20in-swift%203.0-orange.svg)
+
+**Lightbox** is a convenient and easy to use image viewer for your iOS app,
+packed with all the features you expect:
+
+- [x] Paginated image slideshow.
+- [x] Video support.
+- [x] Double-tap to zoom.
+- [x] Image caption.
+- [x] Dynamic background.
+- [x] Interactive transition animations.
+- [x] Powerful configuration.
+- [x] Demo project.
+
+## Table of Contents
+
+* [Usage](#usage)
+  * [Controller](#controller)
+  * [Delegates](#delegates)
+  * [Image loading](#image-loading)
+  * [Video](#video)
+  * [Configuration](#configuration)
+* [Installation](#installation)
+* [Author](#author)
+* [Contributing](#contributing)
+* [License](#license)
 
 ## Usage
 
+### Controller
+
+To start your slideshow just instantiate `LightboxController`, set needed
+delegates and present it:
+
+
+```swift
+
+// Create an array of images.
+let images = [
+  LightboxImage(imageURL: URL(string: "https://cdn.arstechnica.net/2011/10/05/iphone4s_sample_apple-4e8c706-intro.jpg")!),
+  LightboxImage(
+    image: UIImage(named: "photo1")!,
+    text: "This is an example of a remote image loaded from URL"
+  ),
+  LightboxImage(
+    image: UIImage(named: "photo2")!,
+    text: "",
+    videoURL: URL(string: "https://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4")
+  ),
+  LightboxImage(
+    image: UIImage(named: "photo3")!,
+    text: "This is an example of a local image."
+  )
+]
+
+// Create an instance of LightboxController.
+let controller = LightboxController(images: images)
+
+// Set delegates.
+controller.pageDelegate = self
+controller.dismissalDelegate = self
+
+// Use dynamic background.
+controller.dynamicBackground = true
+
+// Present your controller.
+present(controller, animated: true, completion: nil)
+```
+
+### Delegates
+
+Use `LightboxControllerPageDelegate` if you want to be notified about page
+navigation changes.
+
+```swift
+extension ViewController: LightboxControllerPageDelegate {
+
+  func lightboxController(_ controller: LightboxController, didMoveToPage page: Int) {
+    print(page)
+  }
+}
+```
+
+Use `LightboxControllerDismissalDelegate` to be notified when controller is
+about to be dismissed. Please note that `LightboxController` dismisses itself
+if it was presented initially.
+
 ```swift
-<API>
+extension ViewController: LightboxControllerDismissalDelegate: class {
+
+  func lightboxControllerWillDismiss(_ controller: LightboxController) {
+    // ...
+  }
+}
+```
+
+### Image loading
+
+By default images are loaded using `sendAsynchronousRequest` method of
+`NSURLConnection`. But it's easy to change this behavior using **Lightbox**
+configuration.
+
+```swift
+LightboxConfig.loadImage = {
+  imageView, URL, completion in
+  // Custom image loading
+}
+```
+
+### Video
+
+**Lightbox** has video support out of the box. Configure video by using `videoURL`:
+
+```swift
+LightboxImage(
+  image: UIImage(named: "photo2")!,
+  text: "",
+  videoURL: NSURL(string: "https://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4")
+)
+```
+
+Override video handling if needed:
+
+```swift
+LightboxConfig.handleVideo = { from, videoURL in
+  // Custom video handling
+  let videoController = AVPlayerViewController()
+  videoController.player = AVPlayer(url: videoURL)
+
+  from.present(videoController, animated: true) {
+    videoController.player?.play()
+  }
+}
+```
+
+### Configuration
+
+Configure text, colors, fonts of UI elements by overriding the static
+variables in the **Lightbox** [configuration](https://github.com/hyperoslo/Lightbox/blob/master/Source/LightboxConfig.swift) struct. As an example:
+
+```swift
+LightboxConfig.CloseButton.image = UIImage(named: ImageList.Lightbox.closeButton)
+LightboxConfig.CloseButton.textAttributes = TextAttributes.Lightbox.closeButton
+LightboxConfig.CloseButton.text = "Finish"
+
+LightboxConfig.DeleteButton.image = UIImage(named: ImageList.Lightbox.deleteButton)
+LightboxConfig.DeleteButton.textAttributes = TextAttributes.Lightbox.deleteButton
+LightboxConfig.DeleteButton.text = "Delete"
+
+LightboxConfig.InfoLabel.ellipsisText = "ShowMore"
 ```
 
 ## Installation
@@ -20,10 +166,27 @@ it, simply add the following line to your Podfile:
 pod 'Lightbox'
 ```
 
+In order to quickly try the demo project of a **Lightbox** just run
+`pod try Lightbox` in your terminal.
+
+**Lightbox** is also available through [Carthage](https://github.com/Carthage/Carthage).
+To install just write into your Cartfile:
+
+```ruby
+github "hyperoslo/Lightbox"
+```
+
+To install **Lightbox** manually just download and drop `Sources` and
+`Images` folders in your project.
+
 ## Author
 
 Hyper Interaktiv AS, ios@hyper.no
 
+## Contributing
+
+We would love you to contribute to **Lightbox**, check the [CONTRIBUTING](https://github.com/hyperoslo/Lightbox/blob/master/CONTRIBUTING.md) file for more info.
+
 ## License
 
-**Lightbox** is available under the MIT license. See the LICENSE file for more info.
+**Lightbox** is available under the MIT license. See the [LICENSE](https://github.com/hyperoslo/Lightbox/blob/master/LICENSE.md) file for more info.