diff --git a/README.md b/README.md index 16f3e45..a63164f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# Jellyfish Elixir Server SDK +# Fishjam Elixir Server SDK -[![Hex.pm](https://img.shields.io/hexpm/v/jellyfish_server_sdk.svg)](https://hex.pm/packages/jellyfish_server_sdk) -[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/jellyfish_server_sdk/) -[![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) -[![CircleCI](https://circleci.com/gh/jellyfish-dev/elixir_server_sdk.svg?style=svg)](https://circleci.com/gh/jellyfish-dev/elixir_server_sdk) +[![Hex.pm](https://img.shields.io/hexpm/v/fishjam_server_sdk.svg)](https://hex.pm/packages/fishjam_server_sdk) +[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/fishjam_server_sdk/) +[![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) +[![CircleCI](https://circleci.com/gh/fishjam-dev/elixir_server_sdk.svg?style=svg)](https://circleci.com/gh/fishjam-dev/elixir_server_sdk) -Elixir server SDK for [Jellyfish](https://github.com/jellyfish-dev/jellyfish). +Elixir server SDK for [Fishjam](https://github.com/fishjam-dev/fishjam). Currently it allows for: -- making API calls to Jellyfish server (QoL wrapper for HTTP requests) -- listening to Jellyfish server events via WebSocket +- making API calls to Fishjam server (QoL wrapper for HTTP requests) +- listening to Fishjam server events via WebSocket ## Installation @@ -23,11 +23,11 @@ def deps do end ``` -## Jellyfish connection configuration +## Fishjam connection configuration Define the connection configuration in the mix config, specifying server address and authentication token -(for more information see [Jellyfish docs](https://jellyfish-dev.github.io/jellyfish-docs/getting_started/authentication)) +(for more information see [Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/getting_started/authentication)) ``` config.exs config :jellyfish_server_sdk, server_address: "localhost:5002", @@ -50,7 +50,7 @@ client = ## Usage -Make API calls to Jellyfish and receive server events: +Make API calls to Fishjam and receive server events: ```elixir # start process responsible for receiving events @@ -79,17 +79,17 @@ end :ok = Jellyfish.Room.delete_peer(client, room_id, peer_id) ``` -List of structs representing events can be found in the [docs](https://hexdocs.pm/jellyfish_server_sdk). +List of structs representing events can be found in the [docs](https://hexdocs.pm/fishjam_server_sdk). ## Testing -When calling `mix test` it will automatically start the Jellyfish container under the hood. +When calling `mix test` it will automatically start the Fishjam container under the hood. 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`. ## Copyright and License -Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=jellyfish) +Copyright 2023, [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) diff --git a/docker-compose-dev.yaml b/docker-compose-dev.yaml index a445192..e99a3da 100644 --- a/docker-compose-dev.yaml +++ b/docker-compose-dev.yaml @@ -2,7 +2,7 @@ version: "3" services: jellyfish: - image: "ghcr.io/jellyfish-dev/jellyfish:${TAG:-edge}" + image: "ghcr.io/fishjam-dev/jellyfish:${TAG:-edge}" container_name: jellyfish restart: on-failure healthcheck: