Skip to content

Commit ed1424d

Browse files
committed
Improved README
1 parent 2361cb8 commit ed1424d

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ module.exports = {
2020
};
2121
```
2222

23+
Although most of the process is automated, you still have to follow the platform install guide below ([iOS](#ios-install-for-rn--060) and [Android](#android-install)) to get this library to work.
24+
25+
2326
## Use (>= 2.0.0)
2427

2528
The following component is an example of use:
@@ -39,7 +42,7 @@ class VideoCall extends React.Component {
3942
4043
componentDidMount() {
4144
setTimeout(() => {
42-
const url = self.props.navigation.getParam('url');
45+
const url = 'https://your.jitsi.server/roomName'; // can also be only room name and will connect to jitsi meet servers
4346
const userInfo = { displayName: 'User', email: '[email protected]', avatar: 'https:/gravatar.com/avatar/abc123' };
4447
JitsiMeet.call(url, userInfo);
4548
/* You can also use JitsiMeet.audioCall(url) for audio only call */
@@ -70,6 +73,9 @@ class VideoCall extends React.Component {
7073
7174
export default VideoCall;
7275
```
76+
77+
You can also check the [ExampleApp](https://github.com/skrafft/react-native-jitsi-meet/tree/master/ExampleApp)
78+
7379
### Events
7480

7581
You can add listeners for the following events:
@@ -123,11 +129,11 @@ You can add listeners for the following events:
123129
```
124130
contains `<string>voip</string>`
125131

126-
## iOS Manual Install for RN >= 0.60
132+
## iOS Install for RN >= 0.60
127133
1.) Modify your Podfile to have ```platform :ios, '10.0'``` and execute ```pod install```
128134
2.) In Xcode, under Build setting set Enable Bitcode to No
129135

130-
## iOS Manual Install for RN < 0.60
136+
## iOS Install for RN < 0.60
131137
### Step 1. Add Files Into Project
132138
- 1-1.) in Xcode: Right click `Libraries``Add Files to [project]`
133139
- 1-2.) choose `node_modules/react-native-jitsi-meet/ios/RNJitsiMeet.xcodeproj` then `Add`
@@ -229,7 +235,7 @@ done
229235
```
230236
This will run a script everytime you build to clean the unwanted architecture
231237

232-
## Android Manual Install
238+
## Android Install
233239
1.) In `android/app/build.gradle`, add/replace the following lines:
234240

235241
```
@@ -276,7 +282,7 @@ allprojects {
276282
}
277283
```
278284

279-
## Android Additional Manual Install for RN < 0.60
285+
## Android Additional Install for RN < 0.60
280286

281287
1.) In `android/app/src/main/AndroidManifest.xml` add these permissions
282288

0 commit comments

Comments
 (0)