Browse Source

doc: add links to the sample SDK applications repo

master
Saúl Ibarra Corretgé 5 years ago
parent
commit
c1f8a35156
4 changed files with 18 additions and 9 deletions
  1. 1
    1
      README.md
  2. 5
    0
      android/README.md
  3. 7
    8
      doc/mobile.md
  4. 5
    0
      ios/README.md

+ 1
- 1
README.md View File

@@ -33,7 +33,7 @@ You can get our mobile versions from here:
33 33
 
34 34
 ## Building the sources
35 35
 
36
-Node.js >= 8 and npm >= 6 are required.
36
+Node.js >= 10 and npm >= 6 are required.
37 37
 
38 38
 On Debian/Ubuntu systems, the required packages can be installed with:
39 39
 ```

+ 5
- 0
android/README.md View File

@@ -1,5 +1,10 @@
1 1
 # Jitsi Meet SDK for Android
2 2
 
3
+## Sample applications using the SDK
4
+
5
+If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the
6
+[sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples).
7
+
3 8
 ## Build your own, or use a pre-build SDK artifacts/binaries
4 9
 
5 10
 Jitsi conveniently provides a pre-build SDK artifacts/binaries in its Maven repository. When you do not require any

+ 7
- 8
doc/mobile.md View File

@@ -1,13 +1,14 @@
1 1
 # Jitsi Meet apps for Android and iOS
2 2
 
3
-Jitsi Meet can also be built as a standalone app for Android or iOS. It uses the
3
+Jitsi Meet can be built as a standalone app for Android or iOS. It uses the
4 4
 [React Native] framework.
5 5
 
6
+**If you want to rebuild the SDK yourself look in [Android README] or [iOS README].**
7
+
6 8
 First make sure the [React Native dependencies] are installed.
7 9
 
8 10
 **NOTE**: This document assumes the app is being built on a macOS system.
9
-
10
-**NOTE**: Node 6.X and npm 3.X are recommended for building.
11
+**NOTE**: Node 10.X and npm 6.X are recommended for building.
11 12
 
12 13
 
13 14
 ## iOS
@@ -21,8 +22,6 @@ First make sure the [React Native dependencies] are installed.
21 22
     npm install -g ios-deploy
22 23
     ```
23 24
 
24
-    You may need to add ```--unsafe-perm=true``` if you are running on [Mac OS 10.11 or greater](https://github.com/phonegap/ios-deploy#os-x-1011-el-capitan-or-greater).
25
-
26 25
   - Install main dependencies:
27 26
 
28 27
     ```bash
@@ -68,9 +67,7 @@ First make sure the [React Native dependencies] are installed.
68 67
 
69 68
 3. Other remarks
70 69
 
71
-    It's likely you'll need to change the bundle ID for deploying to a device
72
-    because the default bundle ID points to the application signed by Atlassian.
73
-
70
+    It's likely you'll need to change the bundle ID for deploying to a device.
74 71
     This can be changed in the "General" tab.  Under "Identity" set
75 72
     "Bundle Identifier" to a different value, and adjust the "Team" in the
76 73
     "Signing" section to match your own.
@@ -102,6 +99,8 @@ code is being interpreted by Chrome's V8 engine, instead of JSCore which React
102 99
 Native uses. It's important to keep this in mind due to potential differences in
103 100
 supported JavaScript features.
104 101
 
102
+[Android README]: https://github.com/jitsi/jitsi-meet/blob/master/android/README.md
103
+[iOS README]: https://github.com/jitsi/jitsi-meet/blob/master/ios/README.md
105 104
 [Android Studio]: https://developer.android.com/studio/index.html
106 105
 [debugging]: https://facebook.github.io/react-native/docs/debugging.html
107 106
 [React Native]: https://facebook.github.io/react-native/

+ 5
- 0
ios/README.md View File

@@ -3,6 +3,11 @@
3 3
 The Jitsi Meet iOS SDK provides the same user experience as the Jitsi Meet app,
4 4
 in a customizable way which you can embed in your apps.
5 5
 
6
+## Sample applications using the SDK
7
+
8
+If you want to see how easy integrating the Jitsi Meet SDK into a native application is, take a look at the
9
+[sample applications repository](https://github.com/jitsi/jitsi-meet-sdk-samples).
10
+
6 11
 ## Usage
7 12
 
8 13
 There are 2 ways to integrate the SDK into your project:

Loading…
Cancel
Save