Skip to content

Commit 8fe9f0d

Browse files
authored
Update README to use Fishjam (rebranding) (#39)
Update README file to use new name - Fishjam
1 parent 95e49f4 commit 8fe9f0d

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Jellyfish Python Server SDK
1+
# Fishjam Python Server SDK
22

3-
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/jellyfish-dev/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/jellyfish-dev/python-server-sdk/tree/main)
3+
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/fishjam-dev/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/fishjam-dev/python-server-sdk/tree/main)
44

5-
Python server SDK for the [Jellyfish Media Server](https://github.com/jellyfish-dev/jellyfish).
5+
Python server SDK for the [Fishjam Media Server](https://github.com/fishjam-dev/fishjam).
66

7-
Read the docs [here](https://jellyfish-dev.github.io/python-server-sdk)
7+
Read the docs [here](https://fishjam-dev.github.io/python-server-sdk)
88

99
## Installation
1010

@@ -14,22 +14,22 @@ pip install jellyfish-server-sdk
1414

1515
## Usage
1616

17-
The SDK exports two main classes for interacting with Jellyfish server:
17+
The SDK exports two main classes for interacting with Fishjam server:
1818
`RoomApi` and `Notifier`.
1919

2020
`RoomApi` wraps http REST api calls, while `Notifier` is responsible for receiving real-time updates from the server.
2121

2222
#### RoomApi
2323

24-
Create a `RoomApi` instance, providing the jellyfish server address and api token
24+
Create a `RoomApi` instance, providing the fishjam server address and api token
2525

2626
```python
2727
from jellyfish import RoomApi
2828

2929
room_api = RoomApi(server_address="localhost:5002", server_api_token="development")
3030
```
3131

32-
You can use it to interact with Jellyfish, manage rooms, peers and components
32+
You can use it to interact with Fishjam, manage rooms, peers and components
3333

3434
```python
3535
# Create a room
@@ -53,9 +53,9 @@ All methods in `RoomApi` may raise one of the exceptions deriving from `jellyfis
5353

5454
#### Notifier
5555

56-
Notifier allows for receiving real-time updates from the Jellyfish Server.
56+
Notifier allows for receiving real-time updates from the Fishjam Server.
5757

58-
You can read more about notifications in the [Jellyfish Docs](https://jellyfish-dev.github.io/jellyfish-docs/next/getting_started/notifications).
58+
You can read more about notifications in the [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/next/getting_started/notifications).
5959

6060
Create `Notifier` instance
6161
```python
@@ -95,9 +95,9 @@ asyncio.run(test_notifier())
9595
# Received WebRTC metrics: ServerMessageMetricsReport(metrics='{}')
9696
```
9797

98-
#### Cluster of Jellyfishes
98+
#### Cluster of Fishjams
9999

100-
The cluster of jellyfishes has got embedded load balancer, which means that a new room will be created on jellyfish with the least usage. At the moment to modify this specific room you must communicate with the jellyfish on which this room was created.
100+
The cluster of fishjams has got embedded load balancer, which means that a new room will be created on fishjam with the least usage. At the moment to modify this specific room you must communicate with the fishjam on which this room was created.
101101

102102
```python
103103
room_api = RoomApi(server_address='localhost:5002')
@@ -106,12 +106,12 @@ room_api = RoomApi(server_address='localhost:5002')
106106
# that allow to use HLS.
107107
address, room = room_api.create_room(video_codec="h264")
108108

109-
# Create new room api with returned jellyfish address as a room could be
110-
# created on a different jellyfish instance
111-
# (if you communicate with a cluster of jellyfishes)
109+
# Create new room api with returned fishjam address as a room could be
110+
# created on a different fishjam instance
111+
# (if you communicate with a cluster of fishjams)
112112
new_room_api = RoomApi(server_address=address)
113113

114-
# Add HLS component with manual subscribe mode, we use here `new_room_api` as we are sure that this API refers to the jellyfish on which this room was created.
114+
# Add HLS component with manual subscribe mode, we use here `new_room_api` as we are sure that this API refers to the fishjam on which this room was created.
115115
_hls_component = new_room_api.add_component(
116116
room.id,
117117
ComponentOptionsHLS(subscribe_mode=ComponentOptionsHLSSubscribeMode.MANUAL),
@@ -143,8 +143,8 @@ poetry run lint
143143

144144
## Copyright and License
145145

146-
Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish)
146+
Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
147147

148-
[![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)
148+
[![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)
149149

150150
Licensed under the [Apache License, Version 2.0](LICENSE)

docker-compose-test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "3"
22

33
services:
44
jellyfish:
5-
image: "ghcr.io/jellyfish-dev/jellyfish:${TAG:-edge}"
5+
image: "ghcr.io/fishjam-dev/jellyfish:${TAG:-edge}"
66
container_name: jellyfish
77
restart: on-failure
88
healthcheck:

0 commit comments

Comments
 (0)