Skip to content

Commit 375c426

Browse files
authored
Fix broken links in README (#184)
1 parent 00bfdf3 commit 375c426

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Use this SDK to add realtime video, audio and data features to your React Native
1616

1717
> [!NOTE]
1818
> This is v2 of the React-Native SDK. When migrating from v1.x to v2.x you might encounter a small set of breaking changes.
19-
> Read the [migration guide](https://docs.livekit.io/guides/migrate-from-v1/) for a detailed overview of what has changed.
19+
> Read the [migration guide](https://docs.livekit.io/recipes/migrate-from-v1/) for a detailed overview of what has changed.
2020
2121
## Installation
2222

@@ -295,7 +295,7 @@ Enabling screenshare requires extra installation steps:
295295

296296
Android screenshare requires a foreground service with type `mediaProjection` to be present.
297297

298-
From version 2.4.0 onwards, the foreground service is handled internally,
298+
From version 2.4.0 onwards, the foreground service is handled internally,
299299
but you must declare the permission yourself in your app's AndroidManifest.xml file.
300300

301301
```
@@ -375,15 +375,15 @@ Once setup, [start the foreground service](https://github.com/livekit/client-sdk
375375

376376
### iOS
377377

378-
By default, simple background processing can be enabled by selecting the `audio` and `voip`
379-
[UIBackgroundModes](https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes)
378+
By default, simple background processing can be enabled by selecting the `audio` and `voip`
379+
[UIBackgroundModes](https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes)
380380
in your XCode project. In your project, select your app target -> Signing & Capabilities -> Add Capability -> Background Modes.
381381

382382
These background modes will keep the app alive in the background as long as a mic or audio track is playing.
383383

384-
For a more robust background that isn't sensitive to the above conditions, we suggest using
385-
[CallKit](https://developer.apple.com/documentation/callkit/) to maintain the
386-
connection while in the background. The example uses
384+
For a more robust background that isn't sensitive to the above conditions, we suggest using
385+
[CallKit](https://developer.apple.com/documentation/callkit/) to maintain the
386+
connection while in the background. The example uses
387387
[react-native-callkeep](https://github.com/react-native-webrtc/react-native-callkeep)
388388
for simple integration with CallKit.
389389

docs/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<blockquote>
1616
<p>[!NOTE]
1717
This is v2 of the React-Native SDK. When migrating from v1.x to v2.x you might encounter a small set of breaking changes.
18-
Read the <a href="https://docs.livekit.io/guides/migrate-from-v1/">migration guide</a> for a detailed overview of what has changed.</p>
18+
Read the <a href="https://docs.livekit.io/recipes/migrate-from-v1/">migration guide</a> for a detailed overview of what has changed.</p>
1919
</blockquote>
2020
<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><a id="md:npm" class="tsd-anchor"></a><h3><a href="#md:npm">NPM</a></h3><pre><code class="language-sh"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@livekit/react-native</span><span class="hl-1"> </span><span class="hl-2">@livekit/react-native-webrtc</span>
2121
</code><button>Copy</button></pre>
@@ -70,7 +70,7 @@
7070
hook is advised over just configuring the audio session once for the entire audio session.</p>
7171
<a id="md:screenshare" class="tsd-anchor"></a><h2><a href="#md:screenshare">Screenshare</a></h2><p>Enabling screenshare requires extra installation steps:</p>
7272
<a id="md:android-2" class="tsd-anchor"></a><h3><a href="#md:android-2">Android</a></h3><p>Android screenshare requires a foreground service with type <code>mediaProjection</code> to be present.</p>
73-
<p>From version 2.4.0 onwards, the foreground service is handled internally,
73+
<p>From version 2.4.0 onwards, the foreground service is handled internally,
7474
but you must declare the permission yourself in your app&#39;s AndroidManifest.xml file.</p>
7575
<pre><code><span class="hl-1">&lt;</span><span class="hl-6">uses</span><span class="hl-1">-</span><span class="hl-6">permission</span><span class="hl-1"> </span><span class="hl-13">android</span><span class="hl-1">:</span><span class="hl-6">name</span><span class="hl-1">=</span><span class="hl-2">&quot;android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION&quot;</span><span class="hl-1"> /&gt;</span>
7676
</code><button>Copy</button></pre>
@@ -96,13 +96,13 @@
9696
</code><button>Copy</button></pre>
9797
<p>The camera and microphone permissions/foreground service types can be omitted if you are not using those.</p>
9898
<p>Once setup, <a href="https://github.com/livekit/client-sdk-react-native/blob/main/example/src/callservice/CallService.android.ts">start the foreground service</a> to keep the app alive in the background.</p>
99-
<a id="md:ios-3" class="tsd-anchor"></a><h3><a href="#md:ios-3">iOS</a></h3><p>By default, simple background processing can be enabled by selecting the <code>audio</code> and <code>voip</code>
100-
<a href="https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes">UIBackgroundModes</a>
99+
<a id="md:ios-3" class="tsd-anchor"></a><h3><a href="#md:ios-3">iOS</a></h3><p>By default, simple background processing can be enabled by selecting the <code>audio</code> and <code>voip</code>
100+
<a href="https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes">UIBackgroundModes</a>
101101
in your XCode project. In your project, select your app target -&gt; Signing &amp; Capabilities -&gt; Add Capability -&gt; Background Modes.</p>
102102
<p>These background modes will keep the app alive in the background as long as a mic or audio track is playing.</p>
103-
<p>For a more robust background that isn&#39;t sensitive to the above conditions, we suggest using
104-
<a href="https://developer.apple.com/documentation/callkit/">CallKit</a> to maintain the
105-
connection while in the background. The example uses
103+
<p>For a more robust background that isn&#39;t sensitive to the above conditions, we suggest using
104+
<a href="https://developer.apple.com/documentation/callkit/">CallKit</a> to maintain the
105+
connection while in the background. The example uses
106106
<a href="https://github.com/react-native-webrtc/react-native-callkeep">react-native-callkeep</a>
107107
for simple integration with CallKit.</p>
108108
<p>Our example code can be found <a href="https://github.com/livekit/client-sdk-react-native/blob/main/example/src/callservice/CallService.ios.ts">here</a>.</p>

0 commit comments

Comments
 (0)