doc: add links to the sample SDK applications repo

This commit is contained in:
Saúl Ibarra Corretgé 2019-04-16 21:06:08 +02:00 committed by Saúl Ibarra Corretgé
parent 866dc4dbc6
commit c1f8a35156
4 changed files with 18 additions and 9 deletions

View File

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

View File

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

View File

@ -1,13 +1,14 @@
# Jitsi Meet apps for Android and iOS # Jitsi Meet apps for Android and iOS
Jitsi Meet can also be built as a standalone app for Android or iOS. It uses the Jitsi Meet can be built as a standalone app for Android or iOS. It uses the
[React Native] framework. [React Native] framework.
**If you want to rebuild the SDK yourself look in [Android README] or [iOS README].**
First make sure the [React Native dependencies] are installed. First make sure the [React Native dependencies] are installed.
**NOTE**: This document assumes the app is being built on a macOS system. **NOTE**: This document assumes the app is being built on a macOS system.
**NOTE**: Node 10.X and npm 6.X are recommended for building.
**NOTE**: Node 6.X and npm 3.X are recommended for building.
## iOS ## iOS
@ -21,8 +22,6 @@ First make sure the [React Native dependencies] are installed.
npm install -g ios-deploy npm install -g ios-deploy
``` ```
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).
- Install main dependencies: - Install main dependencies:
```bash ```bash
@ -68,9 +67,7 @@ First make sure the [React Native dependencies] are installed.
3. Other remarks 3. Other remarks
It's likely you'll need to change the bundle ID for deploying to a device It's likely you'll need to change the bundle ID for deploying to a device.
because the default bundle ID points to the application signed by Atlassian.
This can be changed in the "General" tab. Under "Identity" set This can be changed in the "General" tab. Under "Identity" set
"Bundle Identifier" to a different value, and adjust the "Team" in the "Bundle Identifier" to a different value, and adjust the "Team" in the
"Signing" section to match your own. "Signing" section to match your own.
@ -102,6 +99,8 @@ code is being interpreted by Chrome's V8 engine, instead of JSCore which React
Native uses. It's important to keep this in mind due to potential differences in Native uses. It's important to keep this in mind due to potential differences in
supported JavaScript features. supported JavaScript features.
[Android README]: https://github.com/jitsi/jitsi-meet/blob/master/android/README.md
[iOS README]: https://github.com/jitsi/jitsi-meet/blob/master/ios/README.md
[Android Studio]: https://developer.android.com/studio/index.html [Android Studio]: https://developer.android.com/studio/index.html
[debugging]: https://facebook.github.io/react-native/docs/debugging.html [debugging]: https://facebook.github.io/react-native/docs/debugging.html
[React Native]: https://facebook.github.io/react-native/ [React Native]: https://facebook.github.io/react-native/

View File

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