Add CLI release tooling
This commit is contained in:
32
README.md
32
README.md
@@ -17,6 +17,28 @@ Small Go library for querying Minecraft Java and Bedrock server status.
|
||||
go get github.com/VexoraDevelopment/mcstatus
|
||||
```
|
||||
|
||||
## CLI
|
||||
|
||||
The repository also ships a small CLI in `cmd/mcstatus`.
|
||||
|
||||
Build locally:
|
||||
|
||||
```bash
|
||||
go build -o mcstatus ./cmd/mcstatus
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
mcstatus mc.hypixel.net
|
||||
mcstatus java -json mc.hypixel.net
|
||||
mcstatus bedrock -query play.example.com:19132
|
||||
mcstatus auto -pretty localhost
|
||||
mcstatus java -motd-raw mc.hypixel.net
|
||||
```
|
||||
|
||||
If you prefer prebuilt binaries, use the files attached to GitHub Releases.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```go
|
||||
@@ -52,6 +74,16 @@ func main() {
|
||||
- `github.com/VexoraDevelopment/mcstatus/bedrock`
|
||||
- `github.com/VexoraDevelopment/mcstatus/text`
|
||||
|
||||
## Releases
|
||||
|
||||
Pushing a tag like `v1.0.1` triggers GitHub Actions and publishes release archives for:
|
||||
|
||||
- Windows
|
||||
- Linux
|
||||
- macOS
|
||||
|
||||
using the `mcstatus` CLI binary from `cmd/mcstatus`.
|
||||
|
||||
## Notes
|
||||
|
||||
- `ServerInfo` is a plain struct and can be stored however you want.
|
||||
|
||||
Reference in New Issue
Block a user