From 5e5d5ab05e9dd0116299dccb3dc963f57c63f10d Mon Sep 17 00:00:00 2001 From: Cain <75994858+cainthebest@users.noreply.github.com> Date: Mon, 15 Jul 2024 11:42:38 +0100 Subject: [PATCH] chore(cli): update readme --- crates/cli/README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/crates/cli/README.md b/crates/cli/README.md index 2cd3d56..c1e1794 100644 --- a/crates/cli/README.md +++ b/crates/cli/README.md @@ -2,7 +2,7 @@ The official [rust-GameDig](https://crates.io/crates/gamedig) Command Line Interface. -[![CI](https://github.com/gamedig/rust-gamedig/actions/workflows/ci.yml/badge.svg)](https://github.com/gamedig/rust-gamedig/actions) [![Latest Version](https://img.shields.io/crates/v/gamedig-cli.svg?color=yellow)](https://crates.io/crates/gamedig-cli) [![Crates.io](https://img.shields.io/crates/d/gamedig-cli?color=purple)](https://crates.io/crates/gamedig-cli) [![License:MIT](https://img.shields.io/github/license/gamedig/rust-gamedig?color=blue)](https://github.com/gamedig/rust-gamedig/blob/main/LICENSE.md) [![node coverage](https://raw.githubusercontent.com/gamedig/rust-gamedig/main/.github/badges/node.svg)](https://github.com/gamedig/node-gamedig) +[![CI](https://github.com/gamedig/rust-gamedig/actions/workflows/ci.yml/badge.svg)](https://github.com/gamedig/rust-gamedig/actions) [![License:MIT](https://img.shields.io/github/license/gamedig/rust-gamedig?color=blue)](https://github.com/gamedig/rust-gamedig/blob/main/LICENSE.md) [![node coverage](https://raw.githubusercontent.com/gamedig/rust-gamedig/main/.github/badges/node.svg)](https://github.com/gamedig/node-gamedig) ## Community @@ -32,9 +32,9 @@ gamedig-cli query -g teamfortress2 -i 127.0.0.1 -f json-pretty What we are doing here: -* `-g` (or `--game`) specifies the game. -* `-i` (or `--ip`) target ip. -* `-f` (or `--format`) our preferred format. +- `-g` (or `--game`) specifies the game. +- `-i` (or `--ip`) target ip. +- `-f` (or `--format`) our preferred format. Note: We haven't specified a port (via `-p` or `--port`), so the default one for the game will be used (`27015` in this case). @@ -56,12 +56,6 @@ Response (note that some games have a different structure): } ``` -## Documentation - -The documentation is available at [docs.rs](https://docs.rs/gamedig/latest/gamedig-cli/). -Curious about the history and what changed between versions? Everything is in -the [CHANGELOG](https://github.com/gamedig/rust-gamedig/blob/main/crates/cli/CHANGELOG.md) file. - ## Contributing Please read [CONTRIBUTING](https://github.com/gamedig/rust-gamedig/blob/main/CONTRIBUTING.md).