Skip to content

Commit

Permalink
Update Cargo.toml and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cblanken committed Jun 1, 2023
1 parent 844e6a2 commit a8f4fc9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 23 deletions.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ license = "MIT"
license-file = "LICENSE.md"
keywords = ["rcon", "RCON"]
categories = ["command-line-utilities", "network-programming"]
homepage = "https://github.com/cblanken/rustcon"
repository = "https://github.com/cblanken/rustcon"
readme = "README.md"

[dependencies]
array-bytes = { version = "1.5.1" }
Expand Down
36 changes: 13 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,20 @@
# RustCON
![rust-logo](https://img.shields.io/badge/Rust-2018-red?logo=rust)
![license](https://img.shields.io/github/license/cblanken/rustcon?label=License)

RustCON is an [RCON](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) client written in Rust for game server administration.


## Installation
```console
$ cargo install rustcon
```

## Usage
TODO: binary usage / argument description

## Demo
TODO: gif demo using client

## Feature goals
- [x] Authentication
- [x] Send/receive commands
- [x] Basic RCON command prompt
- [ ] Correctly receive large (4096+ B) packets that are split
- [ ] Maintain command history
- [ ] Configs
- [x] Optionally read password from RCON_PASS env variable
- [ ] Provide autocomplete
- [ ] Robust Error Handling
- [x] Re-ask for password when getting invalid auth response
- [x] Handle invalid password and command inputs
- [x] Automatcially retry lost connection
- [ ] Signal handling (Ctrl+c) etc.
- [ ] TUI
- [x] CLI
- [ ] Help menu
- [ ] Description / more info popup
- [ ] Autofill
- [ ] Autocomplete
- [ ] Commands
- [ ] Subcommands
- [ ] Users
## License
All files MIT © Cameron Blankenkenbuehler per the [license](./LICENSE.md).

0 comments on commit a8f4fc9

Please sign in to comment.