Skip to content

Commit

Permalink
Requested changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolk99 committed Nov 13, 2024
1 parent 9723d68 commit 448011c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Running (in dev mode)
All available options are defined in [arguments.py](room_manager/arguments.py).

```sh
```console
poetry install
poetry run room_manager # Room Manager has to be started in the project root directory
```
Expand All @@ -14,13 +14,11 @@ Fishjam Room Manager serves the purpose of a simple backend that allows users to
Users must provide a room name and their username to obtain an authentication token that allows them to connect to a Fishjam instance.
Room Manager manages the room names and user names by itself by keeping the mappings in memory.

As of now, it exposes 3 endpoints.
As of now, it exposes 2 endpoints.

### '/api/rooms/:roomName/users/:username'

Simple as that - send a plain GET request and receive an auth token.
Room Manager will search its memory for the username for the requested room and return a token.
Otherwise, it will create a new one.
Returns authentication token for a username in a given room. If the user doesn't exist yet, it will be created.

### '/api/rooms/webhook'

Expand Down
2 changes: 1 addition & 1 deletion poetry_scripts.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def start_room_manager():

if current_folder != "python-server-sdk":
raise RuntimeError(
"Room Manager has to be start from the `python-server-sdk` directory."
"Room Manager has to be started from the `python-server-sdk` directory."
)

subprocess.run(
Expand Down

0 comments on commit 448011c

Please sign in to comment.