Skip to content

Commit e95e8c8

Browse files
committed
chore: update readme
1 parent b8e9146 commit e95e8c8

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
- [Local Development](#local-development)
55
- [Features](#features)
66
- [Installation](#installation)
7+
- [Binary](#binary)
8+
- [Docker](#docker)
9+
- [Go](#go)
10+
- [Windows](#windows)
711
- [Usage](#usage)
812
- [Interactive Mode](#interactive-mode)
913
- [Single Command Mode](#single-command-mode)
@@ -79,6 +83,18 @@ You can use the provided `Makefile` and `compose.yaml` to spin up a local develo
7983

8084
## Installation
8185

86+
### Binary
87+
88+
Linux binaries are available on the [releases page](https://github.com/UltimateForm/tcprcon-cli/releases/latest).
89+
90+
### Docker
91+
92+
```bash
93+
docker run -it ghcr.io/ultimateform/tcprcon-cli:latest --address=192.168.1.100 --port=7778
94+
```
95+
96+
### Go
97+
8298
```bash
8399
go install github.com/UltimateForm/tcprcon-cli@latest
84100
```
@@ -93,6 +109,12 @@ cd tcprcon-cli
93109
go build -o tcprcon-cli .
94110
```
95111

112+
### Windows
113+
114+
Windows is not natively supported due to Unix-specific terminal dependencies. Use [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) or the Docker image above.
115+
116+
Might change my mind about supporting windows in the future but given that this is essentially a CLI app windows is kind of an after thought for me... and there's likely a better UI app for windows out there.
117+
96118
## Usage
97119

98120
### Interactive Mode

0 commit comments

Comments
 (0)