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

Update README to use Fishjam (rebranding) #3

Merged
merged 4 commits into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/) <br/> [React](https://github.com/jellyfish-dev/react-client-sdk) <br/> [iOS](https://github.com/jellyfish-dev/ios-client-sdk) <br/> [Android](https://github.com/jellyfish-dev/android-client-sdk) <br/> [React Native](https://github.com/jellyfish-dev/react-native-client-sdk) |
| ⚙️ Server SDKs | [JavaScript](https://github.com/jellyfish-dev/js-server-sdk) <br/> [Python](https://github.com/jellyfish-dev/python-server-sdk) <br/> [Elixir](https://github.com/jellyfish-dev/elixir_server_sdk) |
| 📚 Resources | [Jellyfish Docs](https://jellyfish-dev.github.io/jellyfish-docs/) <br/> [Membrane Framework](https://membrane.stream/) <br/> [Join Membrane Discord!](https://discord.gg/nwnfVSY) |
| 🪼 Services | [Videoroom](https://github.com/jellyfish-dev/jellyfish_videoroom) <br/> A videoconferencing app built on top of Jellyfish <br/><br/> [Dashboard](https://github.com/jellyfish-dev/jellyfish-dashboard) <br/> An all-around development tool for Jellyfish |
| | |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 📱 Client SDKs | [TypeScript](https://github.com/fishjam-dev/ts-client-sdk/) <br/> [React](https://github.com/fishjam-dev/react-client-sdk) <br/> [iOS](https://github.com/fishjam-dev/ios-client-sdk) <br/> [Android](https://github.com/fishjam-dev/android-client-sdk) <br/> [React Native](https://github.com/fishjam-dev/react-native-client-sdk) |
| ⚙️ Server SDKs | [JavaScript](https://github.com/fishjam-dev/js-server-sdk) <br/> [Python](https://github.com/fishjam-dev/python-server-sdk) <br/> [Elixir](https://github.com/fishjam-dev/elixir_server_sdk) |
| 📚 Resources | [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/) <br/> [Membrane Framework](https://membrane.stream/) <br/> [Join Membrane Discord!](https://discord.gg/nwnfVSY) |
| 🪼 Services | [Videoroom](https://github.com/fishjam-dev/fishjam-videoroom) <br/> A videoconferencing app built on top of Fishjam <br/><br/> [Dashboard](https://github.com/fishjam-dev/fishjam-dashboard) <br/> An all-around development tool for Fishjam |

## Contributing

Expand All @@ -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)
8 changes: 4 additions & 4 deletions examples/room-manager/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -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.