Skip to content

Commit 49df86c

Browse files
authored
Update readme and links to fishjam
* update readme
1 parent 06352f0 commit 49df86c

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

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

3-
[![Hex.pm](https://img.shields.io/hexpm/v/jellyfish_server_sdk.svg)](https://hex.pm/packages/jellyfish_server_sdk)
4-
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/jellyfish_server_sdk/)
5-
[![codecov](https://codecov.io/gh/jellyfish-dev/elixir_server_sdk/branch/master/graph/badge.svg?token=ByIko4o5U8)](https://codecov.io/gh/jellyfish-dev/elixir_server_sdk)
6-
[![CircleCI](https://circleci.com/gh/jellyfish-dev/elixir_server_sdk.svg?style=svg)](https://circleci.com/gh/jellyfish-dev/elixir_server_sdk)
3+
[![Hex.pm](https://img.shields.io/hexpm/v/fishjam_server_sdk.svg)](https://hex.pm/packages/fishjam_server_sdk)
4+
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/fishjam_server_sdk/)
5+
[![codecov](https://codecov.io/gh/fishjam-dev/elixir_server_sdk/branch/master/graph/badge.svg?token=ByIko4o5U8)](https://codecov.io/gh/fishjam-dev/elixir_server_sdk)
6+
[![CircleCI](https://circleci.com/gh/fishjam-dev/elixir_server_sdk.svg?style=svg)](https://circleci.com/gh/fishjam-dev/elixir_server_sdk)
77

8-
Elixir server SDK for [Jellyfish](https://github.com/jellyfish-dev/jellyfish).
8+
Elixir server SDK for [Fishjam](https://github.com/fishjam-dev/fishjam).
99
Currently it allows for:
1010

11-
- making API calls to Jellyfish server (QoL wrapper for HTTP requests)
12-
- listening to Jellyfish server events via WebSocket
11+
- making API calls to Fishjam server (QoL wrapper for HTTP requests)
12+
- listening to Fishjam server events via WebSocket
1313

1414
## Installation
1515

@@ -23,11 +23,11 @@ def deps do
2323
end
2424
```
2525

26-
## Jellyfish connection configuration
26+
## Fishjam connection configuration
2727

2828
Define the connection configuration in the mix config,
2929
specifying server address and authentication token
30-
(for more information see [Jellyfish docs](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/authentication))
30+
(for more information see [Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/getting_started/authentication))
3131
``` config.exs
3232
config :jellyfish_server_sdk,
3333
server_address: "localhost:5002",
@@ -50,7 +50,7 @@ client =
5050

5151
## Usage
5252

53-
Make API calls to Jellyfish and receive server events:
53+
Make API calls to Fishjam and receive server events:
5454

5555
```elixir
5656
# start process responsible for receiving events
@@ -79,17 +79,17 @@ end
7979
:ok = Jellyfish.Room.delete_peer(client, room_id, peer_id)
8080
```
8181

82-
List of structs representing events can be found in the [docs](https://hexdocs.pm/jellyfish_server_sdk).
82+
List of structs representing events can be found in the [docs](https://hexdocs.pm/fishjam_server_sdk).
8383

8484
## Testing
8585

86-
When calling `mix test` it will automatically start the Jellyfish container under the hood.
86+
When calling `mix test` it will automatically start the Fishjam container under the hood.
8787
Tests on CI are run with the use of docker-compose, to run it locally in the same way as on CI run `mix integration_test`.
8888

8989
## Copyright and License
9090

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

93-
[![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)
93+
[![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)
9494

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

docker-compose-dev.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)