From 2d08c389637697225e1dff10a385e15f63069857 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karol=20K=C4=85kol?= Date: Wed, 15 May 2024 17:50:18 +0200 Subject: [PATCH 1/3] update readme --- README.md | 16 ++++++++-------- app/build.gradle | 10 +++++----- .../jellyfishandroidexample/RoomViewModel.kt | 2 +- protos | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a2a5857..beab847 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# Jellyfish Android Client +# Fishjam Android Client -Android client library for [Jellyfish](https://github.com/jellyfish-dev/jellyfish). +Android client library for [Fishjam](https://github.com/jellyfish-dev/jellyfish). ## Documentation @@ -32,7 +32,7 @@ Add the dependency: Make sure you have: -- Running [Jellyfish](https://github.com/jellyfish-dev/jellyfish) server. +- Running [Fishjam](https://github.com/jellyfish-dev/jellyfish) server. - Created room and token of peer in that room. You can use [dashboard](https://jellyfish-dev.github.io/jellyfish-dashboard/) example to create room and peer token. @@ -40,7 +40,7 @@ You can refer to our minimal example on how to use this library. ## Development -1. Set `JELLYFISH_SOCKET_URL` in `~/.gradle/gradle.properties` to your dev backend. +1. Set `FISHJAM_SOCKET_URL` in `~/.gradle/gradle.properties` to your dev backend. 2. Run `./gradlew formatKotlin` to format code. 3. Run `release-it` to release. Follow the prompts, it should add a commit and a git tag and jitpack should pick it up automatically and put the new version in the jitpack repo. @@ -48,17 +48,17 @@ You can refer to our minimal example on how to use this library. We welcome contributions to this SDK. Please report any bugs or issues you find or feel free to make a pull request with your own bug fixes and/or features.` -## Jellyfish Ecosystem +## Fishjam Ecosystem | | | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Client SDKs | [React](https://github.com/jellyfish-dev/react-client-sdk), [React Native](https://github.com/jellyfish-dev/react-native-client-sdk), [iOs](https://github.com/jellyfish-dev/ios-client-sdk), [Android](https://github.com/jellyfish-dev/android-client-sdk) | | Server SDKs | [Elixir](https://github.com/jellyfish-dev/elixir_server_sdk), [Python](https://github.com/jellyfish-dev/python-server-sdk), [OpenAPI](https://jellyfish-dev.github.io/jellyfish-docs/api_reference/rest_api) | | Services | [Videoroom](https://github.com/jellyfish-dev/jellyfish_videoroom) - an example videoconferencing app written in elixir
[Dashboard](https://github.com/jellyfish-dev/jellyfish-dashboard) - an internal tool used to showcase Jellyfish's capabilities | -| Resources | [Jellyfish Book](https://jellyfish-dev.github.io/book/) - theory of the framework, [Docs](https://jellyfish-dev.github.io/jellyfish-docs/), [Tutorials](https://github.com/jellyfish-dev/jellyfish-clients-tutorials) | -| Membrane | Jellyfish is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | +| Resources | [Fishjam Book](https://jellyfish-dev.github.io/book/) - theory of the framework, [Docs](https://jellyfish-dev.github.io/jellyfish-docs/), [Tutorials](https://github.com/jellyfish-dev/jellyfish-clients-tutorials) | +| Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | | Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video | -| Protobufs | If you want to use Jellyfish on your own, you can use our [protobufs](https://github.com/jellyfish-dev/protos) | +| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/jellyfish-dev/protos) | ## Copyright and License diff --git a/app/build.gradle b/app/build.gradle index 5af3a47..716e646 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -21,10 +21,10 @@ android { useSupportLibrary true } - if(project.hasProperty("JELLYFISH_SOCKET_URL")) { - buildConfigField "String", "JELLYFISH_SOCKET_URL", "\"$JELLYFISH_SOCKET_URL\"" + if(project.hasProperty("FISHJAM_SOCKET_URL")) { + buildConfigField "String", "FISHJAM_SOCKET_URL", "\"$FISHJAM_SOCKET_URL\"" } else { - buildConfigField "String" , "JELLYFISH_SOCKET_URL" , "\"ws://localhost:4000/socket/peer/websocket\"" + buildConfigField "String" , "FISHJAM_SOCKET_URL" , "\"ws://localhost:4000/socket/peer/websocket\"" } } @@ -76,6 +76,6 @@ dependencies { androidTestImplementation platform('androidx.compose:compose-bom:2022.10.00') androidTestImplementation 'androidx.compose.ui:ui-test-junit4' androidTestImplementation platform('androidx.compose:compose-bom:2022.10.00') - + testImplementation 'junit:junit:4.13.2' -} \ No newline at end of file +} diff --git a/app/src/main/java/com/example/jellyfishandroidexample/RoomViewModel.kt b/app/src/main/java/com/example/jellyfishandroidexample/RoomViewModel.kt index 2ba21e5..d4e4b04 100644 --- a/app/src/main/java/com/example/jellyfishandroidexample/RoomViewModel.kt +++ b/app/src/main/java/com/example/jellyfishandroidexample/RoomViewModel.kt @@ -32,7 +32,7 @@ class RoomViewModel(application: Application) : fun connect(roomToken: String) { client.connect( Config( - websocketUrl = BuildConfig.JELLYFISH_SOCKET_URL, + websocketUrl = BuildConfig.FISHJAM_SOCKET_URL, token = roomToken, ), ) diff --git a/protos b/protos index 662095c..7da5da1 160000 --- a/protos +++ b/protos @@ -1 +1 @@ -Subproject commit 662095c9a8ca30d197458758ec9d1ad279c72f4d +Subproject commit 7da5da127c8e018ee0c845c921f598b10209271c From dc2564bbcbb25a9a1faacc79940e6f2c96a80737 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karol=20K=C4=85kol?= Date: Thu, 16 May 2024 13:56:25 +0200 Subject: [PATCH 2/3] update readme, module.md and links --- JellyfishClient/module.md | 4 ++-- README.md | 30 +++++++++++++++--------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/JellyfishClient/module.md b/JellyfishClient/module.md index 79d8f94..8acd19d 100644 --- a/JellyfishClient/module.md +++ b/JellyfishClient/module.md @@ -1,3 +1,3 @@ -# Module JellyfishClient +# Module FishjamClient -## Overview \ No newline at end of file +## Overview diff --git a/README.md b/README.md index beab847..7b4afb5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Fishjam Android Client -Android client library for [Fishjam](https://github.com/jellyfish-dev/jellyfish). +Android client library for [Fishjam](https://github.com/fishjam-dev/fishjam). ## Documentation -Documentation is available [here](https://jellyfish-dev.github.io/android-client-sdk/). +Documentation is available [here](https://fishjam-dev.github.io/android-client-sdk/). ## Installation @@ -32,9 +32,9 @@ Add the dependency: Make sure you have: -- Running [Fishjam](https://github.com/jellyfish-dev/jellyfish) server. +- Running [Fishjam](https://github.com/fishjam-dev/fishjam) server. - Created room and token of peer in that room. - You can use [dashboard](https://jellyfish-dev.github.io/jellyfish-dashboard/) example to create room and peer token. + You can use [dashboard](https://fishjam-dev.github.io/fishjam-dashboard/) example to create room and peer token. You can refer to our minimal example on how to use this library. @@ -50,20 +50,20 @@ We welcome contributions to this SDK. Please report any bugs or issues you find ## Fishjam Ecosystem -| | | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Client SDKs | [React](https://github.com/jellyfish-dev/react-client-sdk), [React Native](https://github.com/jellyfish-dev/react-native-client-sdk), [iOs](https://github.com/jellyfish-dev/ios-client-sdk), [Android](https://github.com/jellyfish-dev/android-client-sdk) | -| Server SDKs | [Elixir](https://github.com/jellyfish-dev/elixir_server_sdk), [Python](https://github.com/jellyfish-dev/python-server-sdk), [OpenAPI](https://jellyfish-dev.github.io/jellyfish-docs/api_reference/rest_api) | -| Services | [Videoroom](https://github.com/jellyfish-dev/jellyfish_videoroom) - an example videoconferencing app written in elixir
[Dashboard](https://github.com/jellyfish-dev/jellyfish-dashboard) - an internal tool used to showcase Jellyfish's capabilities | -| Resources | [Fishjam Book](https://jellyfish-dev.github.io/book/) - theory of the framework, [Docs](https://jellyfish-dev.github.io/jellyfish-docs/), [Tutorials](https://github.com/jellyfish-dev/jellyfish-clients-tutorials) | -| Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | -| Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video | -| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/jellyfish-dev/protos) | +| | | +| ----------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Client SDKs | [React](https://github.com/fishjam-dev/react-client-sdk), [React Native](https://github.com/fishjam-dev/react-native-client-sdk), [iOS](https://github.com/fishjam-dev/ios-client-sdk), [Android](https://github.com/fishjam-dev/android-client-sdk) | +| Server SDKs | [Elixir](https://github.com/fishjam-dev/elixir_server_sdk), [Python](https://github.com/fishjam-dev/python-server-sdk), [OpenAPI](https://fishjam-dev.github.io/fishjam-docs/api_reference/rest_api) | +| Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) - an example videoconferencing app written in elixir
[Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) - an internal tool used to showcase Fishjam's capabilities | +| Resources | [Fishjam Book](https://fishjam-dev.github.io/book/) - theory of the framework, [Docs](https://fishjam-dev.github.io/fishjam-docs/), [Tutorials](https://github.com/fishjam-dev/fishjam-clients-tutorials) | +| Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | +| Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video | +| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos) | ## Copyright and License -Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish) +Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam) -[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish) +[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam) Licensed under the [Apache License, Version 2.0](LICENSE) From 4aad33c8a7d2030814818192c634e8ef881fcb9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karol=20K=C4=85kol?= Date: Thu, 16 May 2024 13:57:50 +0200 Subject: [PATCH 3/3] update openapi link --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7b4afb5..2ad0910 100644 --- a/README.md +++ b/README.md @@ -50,15 +50,15 @@ We welcome contributions to this SDK. Please report any bugs or issues you find ## Fishjam Ecosystem -| | | -| ----------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | +| ----------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Client SDKs | [React](https://github.com/fishjam-dev/react-client-sdk), [React Native](https://github.com/fishjam-dev/react-native-client-sdk), [iOS](https://github.com/fishjam-dev/ios-client-sdk), [Android](https://github.com/fishjam-dev/android-client-sdk) | -| Server SDKs | [Elixir](https://github.com/fishjam-dev/elixir_server_sdk), [Python](https://github.com/fishjam-dev/python-server-sdk), [OpenAPI](https://fishjam-dev.github.io/fishjam-docs/api_reference/rest_api) | -| Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) - an example videoconferencing app written in elixir
[Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) - an internal tool used to showcase Fishjam's capabilities | -| Resources | [Fishjam Book](https://fishjam-dev.github.io/book/) - theory of the framework, [Docs](https://fishjam-dev.github.io/fishjam-docs/), [Tutorials](https://github.com/fishjam-dev/fishjam-clients-tutorials) | -| Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | -| Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video | -| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos) | +| Server SDKs | [Elixir](https://github.com/fishjam-dev/elixir_server_sdk), [Python](https://github.com/fishjam-dev/python-server-sdk), [OpenAPI](https://fishjam-dev.github.io/fishjam-docs/for_developers/api_reference/rest_api) | +| Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) - an example videoconferencing app written in elixir
[Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) - an internal tool used to showcase Fishjam's capabilities | +| Resources | [Fishjam Book](https://fishjam-dev.github.io/book/) - theory of the framework, [Docs](https://fishjam-dev.github.io/fishjam-docs/), [Tutorials](https://github.com/fishjam-dev/fishjam-clients-tutorials) | +| Membrane | Fishjam is based on [Membrane](https://membrane.stream/), [Discord](https://discord.gg/nwnfVSY) | +| Compositor | [Compositor](https://github.com/membraneframework/membrane_video_compositor_plugin) - Membrane plugin to transform video | +| Protobufs | If you want to use Fishjam on your own, you can use our [protobufs](https://github.com/fishjam-dev/protos) | ## Copyright and License