Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
karkakol committed May 15, 2024
1 parent 11cefd3 commit 2d08c38
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -32,33 +32,33 @@ 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.

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.

## Contributing

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 <br/> [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

Expand Down
10 changes: 5 additions & 5 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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\""
}
}

Expand Down Expand Up @@ -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'
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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,
),
)
Expand Down
2 changes: 1 addition & 1 deletion protos

0 comments on commit 2d08c38

Please sign in to comment.