docs: prepare 0.3.0

WoozyMasta · Jan 14, 2025 · 16cdca9 · 16cdca9
1 parent 66e31a6
commit 16cdca9
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,27 @@ and this project adheres to [Semantic Versioning][].
 ### Removed
 -->
 
+## [0.3.0][] - 2025-01-14
+
+Refactoring and Simplification
+
+### Added
+
+* new `Messages` channel in `Connection` for receiving server messages
+  (authorization status, server notifications) sent by the server not
+  in response to direct commands
+* 32x32 and 64x64 winres icons for cli
+* `.golangci.yml` config and fix linting issues
+* more detailed comments in accordance with godoc
+
+### Changed
+
+* cli args parse now with `jessevdk/go-flags`
+* removed logging from `bercon` and `bercon-cli`
+* dependencies related to cli have been moved to internal packages
+
+[0.3.0]: https://github.com/WoozyMasta/bercon-cli/compare/v0.2.0...v0.3.0
+
 ## [0.2.0][] - 2024-12-11
 
 ### Added
@@ -31,7 +52,7 @@ and this project adheres to [Semantic Versioning][].
 * Aligned fields for all go structures
 * Update dependencies
 
-[0.2.0]: https://github.com/WoozyMasta/bercon-go/releases/tag/v0.2.0
+[0.2.0]: https://github.com/WoozyMasta/bercon-cli/compare/v0.1.1...v0.2.0
 
 ## [0.1.1][] - 2024-12-08
 
@@ -45,15 +66,15 @@ and this project adheres to [Semantic Versioning][].
 * Disabled UPX packer for Windows binaries to prevent false
   positives from some antivirus
 
-[0.1.1]: https://github.com/WoozyMasta/bercon-go/releases/tag/v0.1.1
+[0.1.1]: https://github.com/WoozyMasta/bercon-cli/compare/v0.1.0...v0.1.1
 
 ## [0.1.0][] - 2024-11-28
 
 ### Added
 
 * First public release
 
-[0.1.0]: https://github.com/WoozyMasta/bercon-go/releases/tag/v0.1.0
+[0.1.0]: https://github.com/WoozyMasta/bercon-cli/tree/v0.1.0
 
 <!--links-->
 [Keep a Changelog]: https://keepachangelog.com/en/1.1.0/

diff --git a/README.md b/README.md
@@ -49,23 +49,21 @@ bercon-cli --help
 ```
 
 ```txt
-NAME:
-   bercon-cli - BattlEye RCon CLI
-
-USAGE:
-   bercon-cli [options] command [command, command, ...]
-
-OPTIONS:
-   --ip value, -i value           server IPv4 address (default: "127.0.0.1") [$BERCON_ADDRESS]
-   --port value, -p value         server RCON port (default: 2305) [$BERCON_PORT]
-   --password value, -P value     server RCON password [$BERCON_PASSWORD]
-   --json, -j                     print result in JSON format (default: false) [$BERCON_JSON_OUTPUT]
-   --geo-db value, -g value       path to Country GeoDB mmdb file [$BERCON_GEO_DB]
-   --timeout value, -t value      deadline and timeout in seconds (default: 5) [$BERCON_TIMEOUT]
-   --buffer-size value, -b value  buffer size for RCON connection (default: 1024) [$BERCON_BUFFER_SIZE]
-   --log-level value, -l value    log level (default: "error") [$BERCON_LOG_LEVEL]
-   --version, -v                  print version
-   --help, -h                     show help
+Usage:
+  bercon-cli [OPTIONS] command [command, command, ...]
+
+BattlEye RCon CLI.
+
+Application Options:
+  -i, --ip=          Server IPv4 address (default: 127.0.0.1) [$BERCON_ADDRESS]
+  -P, --password=    Server RCON password [$BERCON_PASSWORD]
+  -g, --geo-db=      Path to Country GeoDB mmdb file [$BERCON_GEO_DB]
+  -p, --port=        Server RCON port (default: 2305) [$BERCON_PORT]
+  -t, --timeout=     Deadline and timeout in seconds (default: 3) [$BERCON_TIMEOUT]
+  -b, --buffer-size= Buffer size for RCON connection (default: 1024) [$BERCON_BUFFER_SIZE]
+  -j, --json         Print result in JSON format [$BERCON_JSON_OUTPUT]
+  -h, --help         Show version, commit, and build time
+  -v, --version      Prints this help message
 ```
 
 You can also use environment variables, they are specified in the help in

diff --git a/cli/main.go b/cli/main.go
@@ -36,9 +36,9 @@ type Options struct {
 	// print result in JSON format
 	JSON bool `short:"j" long:"json" description:"Print result in JSON format" env:"BERCON_JSON_OUTPUT"`
 	// server IPv4 address
-	Help bool `short:"h" long:"help" description:"Show version, commit, and build time;"`
+	Help bool `short:"h" long:"help" description:"Show version, commit, and build time"`
 	// server IPv4 address
-	Version bool `short:"v" long:"version" description:"Prints this help message."`
+	Version bool `short:"v" long:"version" description:"Prints this help message"`
 }
 
 func main() {
@@ -51,7 +51,6 @@ func main() {
 
 	args, err := p.Parse()
 	if err != nil {
-		// fatal(err)
 		os.Exit(0)
 	}