-
Notifications
You must be signed in to change notification settings - Fork 120
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Update README.md
- Loading branch information
Showing
4 changed files
with
48 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
Pod::Spec.new do |s| | ||
s.name = "AXPhotoViewer" | ||
s.version = "1.0" | ||
s.version = "1.0-beta.5" | ||
s.license = { :type => 'MIT', :file => 'LICENSE.md' } | ||
s.summary = "An iPhone/iPad photo gallery viewer, useful for viewing a large number of photos." | ||
s.homepage = "https://github.com/alexhillc/AXPhotoViewer" | ||
s.author = { "Alex Hill" => "[email protected]" } | ||
s.source = { :git => "https://github.com/alexhillc/AXPhotoViewer.git", :tag => "v#{s.version}" } | ||
|
||
s.platform = :ios, '10.0' | ||
s.platform = :ios, '9.0' | ||
s.requires_arc = true | ||
|
||
s.default_subspec = 'Core' | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,27 @@ | ||
# AXPhotoViewer | ||
AXPhotoViewer is an iOS photo viewer that is useful for viewing a very large (or very small!) amount of images and GIFs. This library supports contextual presentation and dismissal, interactive "flick-to-dismiss" behavior, and easily integrates with many third party async image downloading/caching libraries. | ||
AXPhotoViewer is an iOS photo viewer that is useful for viewing a very large (or very small!) amount of images and GIFs. This library supports contextual presentation and dismissal, interactive "flick-to-dismiss" behavior, and easily integrates with many third party async image downloading/caching libraries. | ||
|
||
While AXPhotoViewer has many configurable properties on each of its modules, it is easy to throw down some initialization code and get started: | ||
|
||
```swift | ||
let dataSource = PhotosDataSource(photos: self.photos, prefetchBehavior: .regular) | ||
let pagingConfig = PagingConfig(navigationOrientation: .horizontal) | ||
let transitionInfo = TransitionInfo(startingView: self.startinImageView) { [weak self] (photo, index) -> UIImageView? in | ||
let transitionInfo = TransitionInfo(startingView: self.startingImageView) { [weak self] (photo, index) -> UIImageView? in | ||
return self?.endingImageView | ||
} | ||
|
||
let photosViewController = PhotosViewController(dataSource: dataSource, pagingConfig: pagingConfig, transitionInfo: transitionInfo) | ||
self.present(photosViewController, animated: true, completion: nil) | ||
``` | ||
|
||
### Objective-C interoperability | ||
This library fully supports interop between Objective-C and Swift codebases. If you run into any issues with this, please open a Github issue or submit a pull request with the suggested changes. | ||
|
||
### Installation | ||
Installation can easily be done through Cocoapods: | ||
```ruby | ||
pod install 'AXPhotoViewer', '~> 1.0.0-beta.5' | ||
``` | ||
or, if you prefer not to use Cocoapods, add the contents of the 'Source' directory to your project to get started. | ||
|
||
More info to come. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters