Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
harsh2204 committed Apr 17, 2021
1 parent 8a01d84 commit 80633aa
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ Checkout the frontend demo [here](https://gamepad.harshgupta.dev)

## Quickstart

Download one of the pre-built binaries for your desired platform from [releases](https://github.com/harsh2204/socketjoy/releases/) and simply execute the binary to get the server up and running.
Download one of the pre-built binaries for your desired platform from [releases](https://github.com/harsh2204/socketjoy/releases/).

_**Required**_: Run the executable with `--setup` flag in a terminal to complete the setup process.

Once the setup is done, you can run the executable by either simply double clicking it or running it from a terminal.

To the run the server in debug mode, run the executable in a terminal with `-d` flag.

Expand Down

0 comments on commit 80633aa

Please sign in to comment.