Update README to use Fishjam (rebranding) (#76)

Update README file to use new name - Fishjam

Author: karkakol

CONTRIBUTING.md

@@ -43,7 +43,7 @@ We use [Playwright](https://playwright.dev/) to run e2e tests.
 
 Use the `npm run e2e` command to run them. You may need to install the browsers using this command: `npx playwright install --with-deps`.
 
-The e2e tests start a Jellyfish instance via Docker and [Testcontainers](https://node.testcontainers.org/).
+The e2e tests start a Fishjam instance via Docker and [Testcontainers](https://node.testcontainers.org/).
 
 #### Colima
 

examples/readme.md

@@ -1,22 +1,22 @@
-# Examples for Jellyfish client
+# Examples for Fishjam client
 
 List of examples:
 
-- [minimal-react](https://github.com/jellyfish-dev/react-client-sdk/tree/main/examples/minimal-react) - minimal
-  example of usage of Jellyfish React client:
+- [minimal-react](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples/minimal-react) - minimal
+  example of usage of Fishjam React client:
 
   - TypeScript with React Client
-  - connect to Jellyfish server
+  - connect to Fishjam server
   - join room
   - start broadcasting screen
   - receive media from other peers
   - almost no UI
 
-- [useSetupMedia hook](https://github.com/jellyfish-dev/react-client-sdk/tree/main/examples/use-camera-and-microphone) - minimal
+- [useSetupMedia hook](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples/use-camera-and-microphone-example) - minimal
   example of usage of `useSetupMedia` hook
 
   - TypeScript with React Client
-  - connect to Jellyfish server
+  - connect to Fishjam server
   - join room
   - set up audio and video devices separately
   - start screensharing

readme.md

@@ -1,12 +1,12 @@
-# Jellyfish React client
+# Fishjam React client
 
-React client library for [Jellyfish](https://github.com/jellyfish-dev/jellyfish).
+React client library for [Fishjam](https://github.com/fishjam-dev/fishjam).
 It is a wrapper around
-the [Jellyfish TS client](https://github.com/jellyfish-dev/react-client-sdk/tree/main/src/jellyfish).
+the [Fishjam TS client](https://github.com/fishjam-dev/ts-client-sdk).
 
 ## Documentation
 
-Documentation is available [here](https://jellyfish-dev.github.io/react-client-sdk/) or you can generate it locally:
+Documentation is available [here](https://fishjam-dev.github.io/react-client-sdk/) or you can generate it locally:
 
 ```bash
 npm run docs
@@ -25,16 +25,16 @@ It was tested with `nodejs` version mentioned in `.tool-versions` file.
 ## Usage
 
 For pure TypeScript usage,
-see [Jellyfish TS client](https://github.com/jellyfish-dev/react-client-sdk/tree/main/src/jellyfish).
+see [Fishjam TS client](https://github.com/fishjam-dev/ts-client-sdk).
 
 Prerequisites:
 
-- Running [Jellyfish](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://github.com/jellyfish-dev/jellyfish-dashboard) to create room and peer token.
+  You can use [dashboard](https://github.com/fishjam-dev/fishjam-dashboard) to create room and peer token.
 
 This snippet is based
-on [minimal-react](https://github.com/jellyfish-dev/react-client-sdk/tree/main/examples/minimal-react) example.
+on [minimal-react](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples/minimal-react) example.
 
 ```tsx
 // main.tsx
@@ -67,7 +67,7 @@ export type TrackMetadata = {
 };
 
 // Create a Membrane client instance
-// remember to use JellyfishContextProvider
+// remember to use FishjamContextProvider
 export const { useApi, useTracks, useStatus, useConnect, useDisconnect, JellyfishContextProvider } = create<
   PeerMetadata,
   TrackMetadata
@@ -133,31 +133,31 @@ export const App = () => {
 
 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.
 
-Detailed information about contributing to Jellyfish Dashboard can be found in [contributing](./CONTRIBUTING.md) document.
+Detailed information about contributing to Fishjam Dashboard can be found in [contributing](./CONTRIBUTING.md) document.
 
 ## Examples
 
-For examples, see [examples](https://github.com/jellyfish-dev/react-client-sdk/tree/main/examples) folder.
+For examples, see [examples](https://github.com/fishjam-dev/react-client-sdk/tree/main/examples) folder.
 
 More information about usage of webrtc can be found
-in [MembraneWebRTC documentation](https://jellyfish-dev.github.io/membrane-webrtc-js/).
+in [MembraneWebRTC documentation](https://fishjam-dev.github.io/membrane-webrtc-js/).
 
-## 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)                                                                                                                                                            |
-| 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)                                                                                                                                               |
+|             |                                                                                                                                                                                                                                                      |
+| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 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 <br/> [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)

tests/docker-compose-test.yaml

@@ -2,7 +2,7 @@ version: "3"
 
 services:
   jellyfish:
-    image: "ghcr.io/jellyfish-dev/jellyfish:${JELLYFISH_VERSION:-0.5.0}"
+    image: "ghcr.io/fishjam-dev/jellyfish:${JELLYFISH_VERSION:-0.5.0}"
     container_name: jellyfish
     restart: on-failure
     healthcheck: