Skip to content
This repository was archived by the owner on Mar 26, 2021. It is now read-only.

Commit

Permalink
Merge pull request nytimes#228 from NYTimes/docs/example
Browse files Browse the repository at this point in the history
Add README documentation on Example project dependency management
  • Loading branch information
cdzombak authored Feb 3, 2017
2 parents 369d70e + 0752169 commit 4b073c6
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# NYTPhotoViewer

[![Platform](http://cocoapod-badges.herokuapp.com/p/NYTPhotoViewer/badge.png)](http://cocoadocs.org/docsets/NYTPhotoViewer)
[![Version](http://cocoapod-badges.herokuapp.com/v/NYTPhotoViewer/badge.png)](http://cocoadocs.org/docsets/NYTPhotoViewer)
[![Platform](http://cocoapod-badges.herokuapp.com/p/NYTPhotoViewer/badge.png)](http://cocoadocs.org/docsets/NYTPhotoViewer)
[![Version](http://cocoapod-badges.herokuapp.com/v/NYTPhotoViewer/badge.png)](http://cocoadocs.org/docsets/NYTPhotoViewer)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

NYTPhotoViewer is a slideshow and image viewer that includes double-tap to zoom, captions, support for multiple images, interactive flick to dismiss, animated zooming presentation, and more.
Expand All @@ -17,6 +17,12 @@ NYTPhotosViewController *photosViewController = [[NYTPhotosViewController alloc]
[self presentViewController:photosViewController animated:YES completion:nil];
```
## Running the Example
The Example project uses [Carthage](https://github.com/Carthage/Carthage) to integrate its dependencies. If you don’t have Carthge installed, you can install it via [Homebrew](http://brew.sh) with `brew install carthage`.
Then, in your checkout of the `NYTPhotoViewer` repo, run `carthage checkout --use-submodules`.
## Installation
### Carthage
Expand All @@ -36,7 +42,7 @@ If you don't want support for animated GIFs, you may instead link against only t
NYTPhotoViewer is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your `Podfile`:
```
pod 'NYTPhotoViewer', '~> 1.1.0'
pod 'NYTPhotoViewer'
```
## Requirements
Expand All @@ -49,7 +55,7 @@ See [`CHANGELOG.md`](https://github.com/NYTimes/NYTPhotoViewer/blob/develop/CHAN
## Swift
NYTPhotoViewer is written in Objective-C but is intended to be fully interoperable with Swift. If you experience any interoperability difficulties, please open an issue or pull request and we will work to resolve it.
NYTPhotoViewer is written in Objective-C but is fully interoperable with Swift. If you experience any interoperability difficulties, please open an issue or pull request and we will work to resolve it.
## Inspiration
Expand Down

0 comments on commit 4b073c6

Please sign in to comment.