diff --git a/README.md b/README.md index 63ec01b..a947166 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,39 @@ -# Jellyfish server SDK for JavaScript +# Fishjam server SDK for JavaScript -JavaScript server-side SDK for [Jellyfish](https://github.com/jellyfish-dev/jellyfish). +JavaScript server-side SDK for [Fishjam](https://github.com/fishjam-dev/fishjam). ## Installation You can install the library using `npm`: ```bash -npm install @jellyfish-dev/js-server-sdk +npm install @fishjam-dev/js-server-sdk ``` ## Documentation -The documentation for the latest release is available [here](https://jellyfish-dev.github.io/js-server-sdk/latest). +The documentation for the latest release is available [here](https://fishjam-dev.github.io/js-server-sdk/latest). To generate it locally, run: ```bash npm run docs ``` -For more comprehensive tutorial on the Jellyfish Server, its capabilites and production usage, refer to -[Jellyfish docs](https://jellyfish-dev.github.io/jellyfish-docs/). +For more comprehensive tutorial on the Fishjam Server, its capabilites and production usage, refer to +[Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/). ## Examples -See [examples](https://github.com/jellyfish-dev/js-server-sdk/tree/main/examples) directory. +See [examples](https://github.com/fishjam-dev/js-server-sdk/tree/main/examples) directory. -## Jellyfish ecosystem +## Fishjam ecosystem -| | | -| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 📱 Client SDKs | [JavaScript](https://github.com/jellyfish-dev/ts-client-sdk/)
[React](https://github.com/jellyfish-dev/react-client-sdk)
[iOS](https://github.com/jellyfish-dev/ios-client-sdk)
[Android](https://github.com/jellyfish-dev/android-client-sdk)
[React Native](https://github.com/jellyfish-dev/react-native-client-sdk) | -| ⚙️ Server SDKs | [JavaScript](https://github.com/jellyfish-dev/js-server-sdk)
[Python](https://github.com/jellyfish-dev/python-server-sdk)
[Elixir](https://github.com/jellyfish-dev/elixir_server_sdk) | -| 📚 Resources | [Jellyfish Docs](https://jellyfish-dev.github.io/jellyfish-docs/)
[Membrane Framework](https://membrane.stream/)
[Join Membrane Discord!](https://discord.gg/nwnfVSY) | -| 🪼 Services | [Videoroom](https://github.com/jellyfish-dev/jellyfish_videoroom)
A videoconferencing app built on top of Jellyfish

[Dashboard](https://github.com/jellyfish-dev/jellyfish-dashboard)
An all-around development tool for Jellyfish | +| | | +| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 📱 Client SDKs | [TypeScript](https://github.com/fishjam-dev/ts-client-sdk/)
[React](https://github.com/fishjam-dev/react-client-sdk)
[iOS](https://github.com/fishjam-dev/ios-client-sdk)
[Android](https://github.com/fishjam-dev/android-client-sdk)
[React Native](https://github.com/fishjam-dev/react-native-client-sdk) | +| ⚙️ Server SDKs | [JavaScript](https://github.com/fishjam-dev/js-server-sdk)
[Python](https://github.com/fishjam-dev/python-server-sdk)
[Elixir](https://github.com/fishjam-dev/elixir_server_sdk) | +| 📚 Resources | [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/)
[Membrane Framework](https://membrane.stream/)
[Join Membrane Discord!](https://discord.gg/nwnfVSY) | +| 🪼 Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom)
A videoconferencing app built on top of Fishjam

[Dashboard](https://github.com/fishjam-dev/fishjam-dashboard)
An all-around development tool for Fishjam | ## Contributing @@ -42,8 +42,8 @@ with your own bug fixes or features. ## Copyright and License -Copyright 2024, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish) +Copyright 2024, [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) diff --git a/examples/room-manager/README.md b/examples/room-manager/README.md index 953e656..51f85bb 100644 --- a/examples/room-manager/README.md +++ b/examples/room-manager/README.md @@ -1,6 +1,6 @@ # Room Manager example -A simple web server that uses the SDK to manage rooms and users on a Jellyfish server instance. +A simple web server that uses the SDK to manage rooms and users on a Fishjam server instance. ## Prerequisites @@ -9,7 +9,7 @@ A simple web server that uses the SDK to manage rooms and users on a Jellyfish s ## Running -To start the Jellyfish server and the Room Manager, run the following commands: +To start the Fishjam server and the Room Manager, run the following commands: ```sh EXTERNAL_IP=`ifconfig | grep 192.168 | cut -d ' ' -f 2` JELLYFISH_VERSION=edge docker compose up @@ -29,5 +29,5 @@ curl http://localhost:8080/rooms/exampleRoom/users/exampleUser to obtain the websocket URL and authentication token of the `exampleUser` to connect to the `exampleRoom`. Feel free use the example from -[react-client-sdk](https://github.com/jellyfish-dev/react-client-sdk/tree/main/examples/minimal-react) to test the -connection to the Jellyfish server with the provided token. +[react-client-sdk](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples/minimal-react) to test the +connection to the Fishjam server with the provided token.