Skip to content

Commit

Permalink
doc: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlisaAkiron committed Jan 26, 2024
1 parent 4013538 commit fea727d
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,20 @@ dotnet tool install -g AlisaLab.RconCli

Then you can use the tool by running `rcon` command.

## Usage
## Sample Usages

You can run `rcon --help` to see the usage.
You can run `rcon --help` to see the help message.

### RCON Library

RconCli use 2 different RCON libraries to communicate with the server:

- [RconSharp](https://github.com/stefanodriussi/rconsharp)
- [CoreRCON](https://github.com/Challengermode/CoreRcon)

You can change which library to use by command line options or through the interactive RCON shell command.

If the library to use is not specified, RconCli will use `RconSharp` by default.

### Direct connect

Expand All @@ -35,7 +46,7 @@ Profile file location:

```bash
# Create a profile
rcon profile add <profile name> -H <hostname or IPv4 address> -p <port> -w <password> -d <description>
rcon profile add <profile name> -H <hostname or IPv4 address> -p <port> -w <password> -d <description> -e <rcon library>

# Remove a profile
rcon profile remove <profile name>
Expand All @@ -47,6 +58,14 @@ rcon profile list
rcon connect <profile name>
```

## Third-party libraries

- [RconSharp](https://github.com/stefanodriussi/rconsharp) under `MIT`, for RCON communication
- [CoreRCON](https://github.com/Challengermode/CoreRcon) under `MIT`, for RCON communication
- [Cocona.Lite](https://github.com/mayuki/Cocona) under `MIT`, for command line parsing
- [Spectre.Console](https://github.com/spectreconsole/spectre.console) under `MIT`, for command line UI
- [SonarAnalyzer.CSharp](https://github.com/SonarSource/sonar-dotnet) under `LGPL-3.0`, for code analysis, not included in the release binary

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details

0 comments on commit fea727d

Please sign in to comment.