diff --git a/README.md b/README.md index b3cb3d86..3c844d5e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,17 @@ Try out all the unique features using the CameraKit Demo from the Google Play st Get it on Google Play +- [Features](#features) +- [Setup](#setup) +- [Usage](#usage) + - [Extra Attributes](#extra-attributes) + - [Capturing Images](#capturing-images) + - [Capturing Video](#capturing-video) +- [Automatic Permissions Behavior](#automatic-permissions-behavior) +- [Dynamic Behavior](#dynamic-sizing-behavior) +- [Capture Mode Behavior](#capture-mode-behavior) +- [Credits](#credits) +- [License](#license) ## Features @@ -28,6 +39,54 @@ compile 'com.flurgle:camerakit:1.0.0' ## Usage +To use CameraKit, simply add a `CameraView` to your layout: + +```xml + +``` + +Make sure you override `onResume` and `onPause` in your activity, and make calls respectively to `CameraView.start()` and `CameraView.stop()`. + +```java +@Override +protected void onResume() { + super.onResume(); + cameraView.start(); +} + +@Override +protected void onPause() { + cameraView.stop(); + super.onPause(); +} +``` + +### Extra Attributes + +Extra attributes + +### Capturing images + +Capturing photos + +### Capturing Video + +Capturing video + +## Automatic Permissions Behavior + +Automatic permissions behavior + +## Dynamic Sizing Behavior + +Dynamic sizing behavior + +## Capture Mode Behavior + +Capture mode behavior ## Credits Dylan McIntyre