Remaining readme scaffolding with table of contents

pull/1/head
Dylan McIntyre 8 years ago
parent 5cfa3112a4
commit a81039befe
  1. 59
      README.md

@ -7,6 +7,17 @@ Try out all the unique features using the CameraKit Demo from the Google Play st
<a href='https://play.google.com/store/apps/details?id=com.flurgle.camerakit.demo&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' height='80'/></a>
- [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
<com.flurgle.camerakit.CameraView
android:id="@+id/camera"
android:layout_width="match_parent"
android:layout_height="match_parent" />
```
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

Loading…
Cancel
Save