Skip to content

Commit cbd3142

Browse files
committed
📚 Update README file to state permissions that the native iOS SDK requires for microphone and photo library usage
1 parent c604910 commit cbd3142

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

‎README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,21 @@ npm install instabug-reactnative
117117
react-native link instabug-reactnative
118118
```
119119
120+
## Microphone and Photo Library Usage Description (iOS Only)
121+
Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
122+
123+
For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:
124+
125+
* `NSMicrophoneUsageDescription`
126+
* `NSPhotoLibraryUsageDescription`
127+
128+
If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:
129+
130+
* "`<app name>` needs access to the microphone to be able to attach voice notes."
131+
* "`<app name>` needs access to your photo library for you to be able to attach images."
132+
133+
**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
134+
120135
## Documentation
121136
For more details about the supported APIs and how to use them, you can check our [**Documentation**](https://docs.instabug.com/docs/react-native-overview).
122137

0 commit comments

Comments
 (0)