Skip to content
This repository was archived by the owner on May 6, 2022. It is now read-only.

Commit ddbb73c

Browse files
committed
docs(readme): copy edits from spokestack.io PR review
1 parent 02fb877 commit ddbb73c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Then follow the instructions for each platform to link react-native-spokestack t
3131
<details>
3232
<summary>iOS details</summary>
3333

34+
First, set your iOS deployment target in XCode to 13.0.
35+
3436
### Edit Podfile
3537

3638
Before running `pod install`, make sure to make the following edits.
3739

38-
react-native-spokestack makes use of relatively new APIs only available in iOS 13+. Make sure to set your deployment target to iOS 13 at the top of your Podfile:
39-
40-
Also set your deployment target to 13.0 in your XCode project.
40+
react-native-spokestack makes use of relatively new APIs only available in iOS 13+. Set the deployment target to iOS 13 at the top of your Podfile:
4141

4242
```ruby
4343
platform :ios, '13.0'
@@ -51,7 +51,7 @@ target 'SpokestackExample' do
5151
#...
5252
```
5353

54-
For the time being, `use_frameworks!` does not work with Flipper, so we also need to disable Flipper. Remove any Flipper-related lines in your Podfile. In React Native 0.63.2, they look like this:
54+
For now, `use_frameworks!` does not work with Flipper, so we also need to disable Flipper. Remove any Flipper-related lines in your Podfile. In React Native 0.63.2, they look like this:
5555

5656
```ruby
5757
# X Remove or comment out these lines X
@@ -70,7 +70,7 @@ $ npx pod-install
7070

7171
### Edit Info.plist
7272

73-
Add the following to your Info.plist to enable permissions. In XCode, also ensure your iOS deployment target is set to 13.0 or higher.
73+
Add the following to your Info.plist to enable permissions.
7474

7575
```xml
7676
<key>NSMicrophoneUsageDescription</key>
@@ -157,10 +157,10 @@ Add the necessary permissions to your `AndroidManifest.xml`. The first permissio
157157

158158
### Request RECORD_AUDIO permission
159159

160-
The responsibility to request permission for RECORD_AUDIO on new devices is left to the user, as there are differing strategies for how to handle permissions.
160+
The RECORD_AUDIO permission is special in that it must be both listed in the `AndroidManifest.xml` as well as requested at runtime. There are a couple ways to handle this (react-native-spokestack does not do this for you):
161161

162-
1. Add a screen to your onboarding that explains the need for the permissions used on each platform (RECORD_AUDIO on Android and Microphone and Speech Recognition on iOS). **Recommended**
163-
2. Request the permissions only when needed. This is also a good option as it avoids asking for permission as soon as the app is launched. Avoid asking for permission with no context or without making it clear why it is needed.
162+
1. **Recommended** Add a screen to your onboarding that explains the need for the permissions used on each platform (RECORD_AUDIO on Android and Speech Recognition on iOS). Have a look at [react-native-permissions](https://github.com/zoontek/react-native-permissions) to handle permissions in a more robust way.
163+
2. Request the permissions only when needed, such as when a user taps on a "listen" button. Avoid asking for permission with no context or without explaining why it is needed. In other words, we do not recommend asking for permission on app launch.
164164

165165
While iOS will bring up permissions dialogs automatically for any permissions needed, you must do this manually in Android.
166166

0 commit comments

Comments
 (0)