1
- # Jellyfish Elixir Server SDK
1
+ # Fishjam Elixir Server SDK
2
2
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 )
7
7
8
- Elixir server SDK for [ Jellyfish ] ( https://github.com/jellyfish -dev/jellyfish ) .
8
+ Elixir server SDK for [ Fishjam ] ( https://github.com/fishjam -dev/fishjam ) .
9
9
Currently it allows for:
10
10
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
13
13
14
14
## Installation
15
15
@@ -23,11 +23,11 @@ def deps do
23
23
end
24
24
```
25
25
26
- ## Jellyfish connection configuration
26
+ ## Fishjam connection configuration
27
27
28
28
Define the connection configuration in the mix config,
29
29
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 ) )
31
31
``` config.exs
32
32
config :jellyfish_server_sdk ,
33
33
server_address: " localhost:5002" ,
@@ -50,7 +50,7 @@ client =
50
50
51
51
## Usage
52
52
53
- Make API calls to Jellyfish and receive server events:
53
+ Make API calls to Fishjam and receive server events:
54
54
55
55
``` elixir
56
56
# start process responsible for receiving events
79
79
:ok = Jellyfish .Room .delete_peer (client, room_id, peer_id)
80
80
```
81
81
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 ) .
83
83
84
84
## Testing
85
85
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.
87
87
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 ` .
88
88
89
89
## Copyright and License
90
90
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 )
92
92
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 )
94
94
95
95
Licensed under the [ Apache License, Version 2.0] ( LICENSE )
0 commit comments