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

Update README to use Fishjam (rebranding) #76

Merged
merged 6 commits into from
May 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 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/jellyfish-dev/jellyfish).
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/jellyfish-dev/react-client-sdk/tree/main/src/jellyfish).

## Documentation

Expand All @@ -25,11 +25,11 @@ 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/jellyfish-dev/react-client-sdk/tree/main/src/jellyfish).

Prerequisites:

- 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://github.com/jellyfish-dev/jellyfish-dashboard) to create room and peer token.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -133,7 +133,7 @@ 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

Expand All @@ -142,17 +142,17 @@ For examples, see [examples](https://github.com/jellyfish-dev/react-client-sdk/t
More information about usage of webrtc can be found
in [MembraneWebRTC documentation](https://jellyfish-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) |
| 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 Fishjam'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 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
Loading