status-im
/
react-native-camera-kit
mirror of https://github.com/status-im/react-native-camera-kit.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme for additional clarity

This commit is contained in:
aarongrider 2021-02-23 10:07:42 -08:00
parent 9f83160f3c
commit 9f16c53509
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -54,11 +54,14 @@ Add the following uses-permission to your `AndroidManifest.xml` (usually found a
#### iOS
Add the following usage description to your `Info.plist` (usually found at: `ios/PROJECT_NAME/`)
Add the following usage descriptions to your `Info.plist` (usually found at: `ios/PROJECT_NAME/`)
```xml
<key>NSCameraUsageDescription</key>
<string>For taking photos</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>For saving photos</string>
```
## Running the example project
@ -81,14 +84,15 @@ import { CameraScreen } from 'react-native-camera-kit';
actions={{ rightButtonText: 'Done', leftButtonText: 'Cancel' }}
onBottomButtonPressed={(event) => this.onBottomButtonPressed(event)}
flashImages={{
// optional, images for flash state
on: require('path/to/image'),
off: require('path/to/image'),
auto: require('path/to/image'),
}}
cameraFlipImage={require('path/to/image')}
captureButtonImage={require('path/to/image')}
torchOnImage={require('path/to/image')}
torchOffImage={require('path/to/image')}
cameraFlipImage={require('path/to/image')} // optional, image for flipping camera button
captureButtonImage={require('path/to/image')} // optional, image capture button
torchOnImage={require('path/to/image')} // optional, image for toggling on flash light
torchOffImage={require('path/to/image')} // optional, image for toggling off flash light
hideControls={false} // (default false) optional, hides camera controls
showCapturedImageCount={false} // (default false) optional, show count for photos taken during that capture session
/>