Skip to content

Updated readme #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2016
Merged

Updated readme #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,26 @@

![Demo](/demo.gif?raw=true "Demo")

[![CocoaPods](https://img.shields.io/cocoapods/p/BFRImageViewer.svg)]() [![CocoaPods](https://img.shields.io/cocoapods/v/BFRImageViewer.svg)]() [![CocoaPods](https://img.shields.io/cocoapods/l/BFRImageViewer.svg)]()

###Summary###
The BFRImageViewer is a turnkey solution to present images within your iOS app 🎉! It's based off of the excellent [IDMPhotoBrowser](https://github.com/ideaismobile/IDMPhotoBrowser), but tweaked for our own needs.

If features swipe gestures to dismiss, image scaling, zooming and panning, supports multiple images, image types, and plays nicely with 3D touch! We use it all over the place in [Buffer for iOS](https://itunes.apple.com/us/app/buffer-for-twitter-pinterest/id490474324?mt=8) :-).

###Installation###
The BFRImageViewer is hosted on CocoaPods and is the recommended way to install it:

`pod 'BFRImageViewer'`
```ruby
pod 'BFRImageViewer'
```


###Quickstart###
To get up and running quickly with BFRImageViewer, just initialize it - that's really about it!

//Image source can be an array containing a mix of PHAssets, NSURLs, url strings, or UIImage
BFRImageViewController *imageVC = [[BFRImageViewController alloc] initWithImageSource:@[image]];

```objc
//Image source can be an array containing a mix of PHAssets, NSURLs, url strings, or UIImage
BFRImageViewController *imageVC = [[BFRImageViewController alloc] initWithImageSource:@[image]];
```
From there, you'll have every photo automagically loaded up and be able to page between them. If you want some additional context, just fire up the demo project and take a peek 👌!

###Going Forward###
Expand Down