Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
1and2papa committed Oct 15, 2015
1 parent d9e0740 commit 32b909b
Showing 1 changed file with 13 additions and 24 deletions.
37 changes: 13 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,37 @@

## Introduction

CTAssetsPickerController is an iOS controller that allows picking multiple photos and videos from user's photo library. The usage and look-and-feel are just similar to UIImagePickerController. It uses **ARC** and requires **Photos** framework.
CTAssetsPickerController is a highly customisable iOS controller that allows picking multiple photos and videos from user's photo library. The usage and look-and-feel are just similar to UIImagePickerController. It uses **ARC** and requires **Photos** framework.

![Screenshot](Screenshot.png "Screenshot")
![Screenshot 2](Screenshot-2.png "Screenshot 2")

## Features
1. Picks multiple photos and videos across albums from user's library.
2. Previews assets by long-press gesture.
3. Filters assets for picking only photos or videos.
4. Filters assets or albums by their properties.
5. Support assets stored in iCloud.
6. Achieves average 5x fps.
7. Conforms UIAppearance Protocol.
8. Conforms UIAccessibility Protocol.
9. Highly customisable.
10. Pure Auto Layout. (by [PureLayout](https://github.com/smileyborg/PureLayout))
5. Supports assets stored in iCloud.
6. Optionally shows selection order.
7. Achieves average 5x fps.
8. Conforms UIAppearance Protocol.
9. Conforms UIAccessibility Protocol.
10. Highly customisable.
11. Pure Auto Layout. (Thanks for the great work of [PureLayout](https://github.com/smileyborg/PureLayout))

## Release Notes
* [Release Notes](https://github.com/chiunam/CTAssetsPickerController/releases)

## Minimum Requirement
iOS 9 SDK
iOS 9 SDK, Minimum Deployment Target iOS 8.0

## Adding to your project
1. [CocoaPods](http://cocoapods.org) Podfile

````
platform :ios, '8.0'
pod 'CTAssetsPickerController', '~> 3.0.0'
pod 'CTAssetsPickerController', '~> 3.1.0'
````
2. [Manual Setup](https://github.com/chiunam/CTAssetsPickerController/wiki/Manual-Setup-(v3))
Expand Down Expand Up @@ -78,17 +80,9 @@ iOS 9 SDK
}
````
## Customisation
## Questions, Issues and Suggestions
Customisation can be done by setting properties or implementating delegate methods. See the [demo project](https://github.com/chiunam/CTAssetsPickerController/wiki/Running-demo-app) for the details.
## Localisation
`CTAssetsPicker.strings` contains strings used in the picker. It will be included in `CTAssetsPickerController.bundle` automatically if you add the picker to your project by CocoaPods. You might translate the text or add your translation accordingly. PR is always welcomed if you add translation to the picker.
## App Extensions
When using CTAssetsPickerController in an App Extension, `#define CT_APP_EXTENSIONS` to avoid using unavailable APIs.
Please check with [wiki](https://github.com/chiunam/CTAssetsPickerController/wiki/) and [issues](https://github.com/chiunam/CTAssetsPickerController/issues) for common issues and questions. Please open a [new Issue] (https://github.com/chiunam/CTAssetsPickerController/issues/new) if you run into a problem specific to the picker. Bug reports and pull requests are always welcome.
## Bonus
Expand All @@ -102,15 +96,10 @@ vc.pageIndex = assets.count - 1; // display the last asset
[self.navigationController pushViewController:vc animated:YES];
````


## Documentation
* [Online documentation](http://cocoadocs.org/docsets/CTAssetsPickerController/)


## Note
CTAssetsPickerController does not compress the picked photos and videos. You can retrieve the image or video data of picked assets by the `PHImageManager` object. Please refer the documentation of [`PHImageManager`](https://developer.apple.com/library/prerelease/ios/documentation/Photos/Reference/PHImageManager_Class/index.html).


## License

The MIT License (MIT)
Expand Down

0 comments on commit 32b909b

Please sign in to comment.