Skip to content

Commit bbd91b5

Browse files
committed
Updated Readme
1 parent c45cce2 commit bbd91b5

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
Writing a ground-up solution for taking profile pictures in iOS can be a pain and time consuming. AvatarCapture is a Swift based library inspired by [ZCSAvatarCapture](https://github.com/zshannon/ZCSAvatarCapture) whose purpose is to make it as easy as possible to start your camera(front facing or rear), allow you to snap a photo or choose a photo from your Photos library.
33

44
## Installation
5-
Note: AvatarCapture has a minimum deployment target of iOS 11
5+
Note: AvatarCapture has a minimum deployment target of iOS 10
66

77
Edit your PodFile:
8-
`pod 'AvatarCapture', '1.0.5'`
8+
`pod 'AvatarCapture'`
99

1010
Then run `pod install`
1111

@@ -16,7 +16,6 @@ Then run `pod install`
1616
- Choose a photo from the iPhone library
1717

1818
## Plans
19-
- general code improvements
2019
- allow more flexibility in where buttons are positioned
2120
- add custom elements/subviews
2221
- Change/choose shape of avatar profile
@@ -36,6 +35,12 @@ First, initialize the view controller(anywhere but `viewDidLoad` is common):
3635

3736
In this example, `avatarView` is a UIView defined in a storyboard. Whatever the `width` and `height` of this UIView is will determine the dimensions of the avatar.
3837

38+
## Helper Methods
39+
`startCapture()` - Begins capturing the output from your iPhone camera and displays the on screen buttons to interact with your camera
40+
`endCapture()` - Stops the live preview of the iPhone camera. This method does not need to be explicitly called in most situations
41+
`swapCameras()` - Swaps the live preview from the front to rear camera and vice versa. This method does not need to be explicitly called in most situations.
42+
`showImagePicker()` - Displays the Photos library for choosing an image
43+
3944
## How do I get my image?
4045
Once you've subscribed to the `AvatarCaptureControllerDelegate` protocol, you can be notified when an image was selected and when the image selection was cancelled:
4146

0 commit comments

Comments
 (0)