Skip to content

Commit 8349f0c

Browse files
committed
remove unnecessary install instructions
1 parent 99f1fb0 commit 8349f0c

3 files changed

Lines changed: 13 additions & 19 deletions

File tree

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
react-native-document-scanner.js.org

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,17 @@ After installing the plugin, you need to follow the steps below
1919

2020
### iOS
2121

22-
1. Open `ios/Podfile` and set `platform :ios` to `13` or higher
23-
24-
2. iOS requires the following usage description be added and filled out for your app in `Info.plist`:
22+
1. iOS requires the following usage description be added and filled out for your app in `Info.plist`:
2523

2624
- `NSCameraUsageDescription` (`Privacy - Camera Usage Description`)
2725

28-
3. Install pods by running
26+
2. Install pods by running
2927
```bash
3028
cd ios && pod install && cd ..
3129
```
3230

3331
### Android
3432

35-
1. Open `android/gradle.properties` and add `org.gradle.jvmargs=-Xmx2048m`
36-
3733
**Note:** You don't need to prompt the user to accept camera permissions for this plugin to work unless you're using another plugin that requires the user to accept camera permissions. See [Android Camera Permissions](#android-camera-permissions).
3834

3935
## Examples
@@ -43,7 +39,8 @@ cd ios && pod install && cd ..
4339

4440
### Basic Example
4541

46-
```javascript
42+
<!-- {% raw %} -->
43+
```jsx
4744
import React, { useState, useEffect } from 'react'
4845
import { Image } from 'react-native'
4946
import DocumentScanner from 'react-native-document-scanner-plugin'
@@ -76,6 +73,7 @@ export default () => {
7673
)
7774
}
7875
```
76+
<!-- {% endraw %} -->
7977

8078
Here's what this example looks like with several items
8179

@@ -105,7 +103,8 @@ You can limit the number of scans. For example if your app lets a user scan a bu
105103
card you might want them to only capture the front and back. In this case you can set
106104
maxNumDocuments to 2. This only works on Android.
107105

108-
```javascript
106+
<!-- {% raw %} -->
107+
```jsx
109108
import React, { useState, useEffect } from 'react'
110109
import { Image } from 'react-native'
111110
import DocumentScanner from 'react-native-document-scanner-plugin'
@@ -140,6 +139,7 @@ export default () => {
140139
)
141140
}
142141
```
142+
<!-- {% endraw %} -->
143143

144144
<video src="https://user-images.githubusercontent.com/26162804/161643345-6fe15f33-9414-46f5-b5d5-24d88948e801.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643345-6fe15f33-9414-46f5-b5d5-24d88948e801.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
145145

@@ -249,7 +249,8 @@ In that case if you don't request camera permissions you get this error
249249

250250
Here's an example of how to request camera permissions.
251251

252-
```javascript
252+
<!-- {% raw %} -->
253+
```jsx
253254
import React, { useState, useEffect } from 'react'
254255
import { Platform, PermissionsAndroid, Image, Alert } from 'react-native'
255256
import DocumentScanner from 'react-native-document-scanner-plugin'
@@ -290,13 +291,4 @@ export default () => {
290291
)
291292
}
292293
```
293-
294-
## License
295-
296-
Copyright 2021 David Marcus
297-
298-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
299-
300-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
301-
302-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
294+
<!-- {% endraw %} -->

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

0 commit comments

Comments
 (0)