Skip to content

Commit 582b21f

Browse files
authored
Rename to Fishjam in README (#195)
1 parent c33af36 commit 582b21f

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
# Jellyfish
1+
# Fishjam
22

3-
[![codecov](https://codecov.io/gh/jellyfish-dev/jellyfish/branch/main/graph/badge.svg?token=ANWFKV2EDP)](https://codecov.io/gh/jellyfish-dev/jellyfish)
4-
[![CircleCI](https://circleci.com/gh/jellyfish-dev/jellyfish.svg?style=svg)](https://circleci.com/gh/jellyfish-dev/jellyfish)
3+
[![codecov](https://codecov.io/gh/fishjam-dev/fishjam/branch/main/graph/badge.svg?token=ANWFKV2EDP)](https://codecov.io/gh/fishjam-dev/fishjam)
4+
[![CircleCI](https://circleci.com/gh/fishjam-dev/fishjam.svg?style=svg)](https://circleci.com/gh/fishjam-dev/fishjam)
55

6-
Jellyfish is an open-source, general-purpose media server that ships with support for multiple media protocols.
6+
Fishjam is an open-source, general-purpose media server that ships with support for multiple media protocols.
77
It can be thought of as a multimedia bridge meant for creating different types of multimedia systems that lets
88
you easily create a real-time video conferencing system, a broadcasting solution, or both at the same time.
99

10-
It leverages the [Membrane RTC Engine](https://github.com/jellyfish-dev/membrane_rtc_engine), a real-time communication engine/SFU library built with [Membrane](https://membrane.stream/).
10+
It leverages the [Membrane RTC Engine](https://github.com/fishjam-dev/membrane_rtc_engine), a real-time communication engine/SFU library built with [Membrane](https://membrane.stream/).
1111

1212
## Installation
1313

14-
There are two ways of running Jellyfish:
14+
There are two ways of running Fishjam:
1515
- building from source (requires Elixir and native dependencies)
16-
- using Jellyfish Docker images
16+
- using Fishjam Docker images
1717

18-
To learn more, refer to [Installation page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/installation) in Jellyfish docs.
18+
To learn more, refer to [Installation page](https://fishjam-dev.github.io/fishjam-docs/getting_started/installation) in Fishjam docs.
1919

2020
## SDKs
2121

22-
Jellyfish provides server SDKs (used to manage the state of Jellyfish server) and client SDKs (used to connect to the Jellyfish instance, receive media, etc.).
22+
Fishjam provides server SDKs (used to manage the state of Fishjam server) and client SDKs (used to connect to the Fishjam instance, receive media, etc.).
2323

24-
To get the list of all available SDKs, go to [SDKs page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/sdks) in Jellyfish docs.
24+
To get the list of all available SDKs, go to [SDKs page](https://fishjam-dev.github.io/fishjam-docs/getting_started/sdks) in Fishjam docs.
2525

2626
## Examples
2727

2828
- WebRTC Dashboard
2929

30-
A standalone dashboard that can create rooms, add peers and send media between the peers. Available [here](https://github.com/jellyfish-dev/jellyfish-dashboard).
31-
To use the dashboard, you need to set up Jellyfish with WebRTC, refer to [WebRTC peer page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/peers/webrtc) in Jellyfish docs to learn how to do that.
32-
Dashboard makes HTTP requests to Jellyfish that need to be authorized and requires a token to do so, learn more from [Authentication page](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/authentication) in Jellyfish docs.
30+
A standalone dashboard that can create rooms, add peers and send media between the peers. Available [here](https://github.com/fishjam-dev/fishjam-dashboard).
31+
To use the dashboard, you need to set up Fishjam with WebRTC, refer to [WebRTC peer page](https://fishjam-dev.github.io/fishjam-docs/getting_started/peers/webrtc) in Fishjam docs to learn how to do that.
32+
Dashboard makes HTTP requests to Fishjam that need to be authorized and requires a token to do so, learn more from [Authentication page](https://fishjam-dev.github.io/fishjam-docs/getting_started/authentication) in Fishjam docs.
3333

3434
## Documentation
3535

36-
Everything you need to get started with Jellyfish is available in the [Jellyfish docs](https://jellyfish-dev.github.io/jellyfish-docs/).
36+
Everything you need to get started with Fishjam is available in the [Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/).
3737

38-
You can read about theoretical concepts and problems we encountered in the [Jellybook](https://jellyfish-dev.github.io/book/).
38+
You can read about theoretical concepts and problems we encountered in the [Fishjambook](https://fishjam-dev.github.io/book/).
3939

4040
## Copyright and License
4141

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

44-
[![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)
44+
[![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)
4545

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

0 commit comments

Comments
 (0)