From a49e0c440dabd1c5e27f4b3375419f24a0877702 Mon Sep 17 00:00:00 2001 From: John Behm Date: Thu, 1 Feb 2024 13:39:45 +0100 Subject: [PATCH] update readme & help messages --- .gitignore | 1 + cmd/root.go | 4 ++-- readme.md | 18 +++++++++--------- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index 047dc9e..bb146db 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .env +TeeworldsEconVPNDetection TeeworldsEconVPNDetectionGo *.txt .vscode/settings.json diff --git a/cmd/root.go b/cmd/root.go index 5a9c3a2..75ea13d 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -24,8 +24,8 @@ func NewRootCmd() *cobra.Command { // cmd represents the run command cmd := &cobra.Command{ - Use: "TeeworldsEconVPNDetectionGo", - Short: "TeeworldsEconVPNDetectionGo is a tool for detecting and banning VPN user on a Teeworlds server.", + Use: "TeeworldsEconVPNDetection", + Short: "TeeworldsEconVPNDetection is a tool for detecting and banning VPN user on a Teeworlds server.", SilenceUsage: true, RunE: rootContext.RunE, Args: cobra.ExactArgs(0), diff --git a/readme.md b/readme.md index 08999b2..f74d498 100644 --- a/readme.md +++ b/readme.md @@ -54,7 +54,7 @@ Use `sample.env` as reference or check out the help of the application. Run the econ log parser with the VPN detection. ```shell -$ ./TeeworldsEconVPNDetectionGo --help +$ ./TeeworldsEconVPNDetection --help Environment variables: TWVPN_IPHUB_TOKEN api key for iphub.info TWVPN_PROXYCHECK_TOKEN api key for proxycheck.io @@ -74,8 +74,8 @@ Environment variables: TWVPN_IP_BLACKLIST comma separated list of ip ranges to blacklist Usage: - TeeworldsEconVPNDetectionGo [flags] - TeeworldsEconVPNDetectionGo [command] + TeeworldsEconVPNDetection [flags] + TeeworldsEconVPNDetection [command] Available Commands: add add ips to the database (blacklist) @@ -87,7 +87,7 @@ Flags: -c, --config string .env config file path (or via env variable TWVPN_CONFIG) --econ-addresses string comma separated list of econ addresses --econ-passwords string comma separated list of econ passwords - -h, --help help for TeeworldsEconVPNDetectionGo + -h, --help help for TeeworldsEconVPNDetection --ip-blacklist string comma separated list of ip ranges to blacklist --ip-whitelist string comma separated list of ip ranges to whitelist --iphub-token string api key for iphub.info @@ -103,19 +103,19 @@ Flags: --vpn-ban-duration duration (default 5m0s) --vpn-ban-reason string (default "VPN") -Use "TeeworldsEconVPNDetectionGo [command] --help" for more information about a command. +Use "TeeworldsEconVPNDetection [command] --help" for more information about a command. ``` Add ips to the database (blacklist) ```shell -$ ./TeeworldsEconVPNDetectionGo add --help +$ ./TeeworldsEconVPNDetection add --help Environment variables: TWVPN_REDIS_ADDRESS (default: "localhost:6379") TWVPN_REDIS_PASSWORD TWVPN_REDIS_DB_VPN (default: "15") Usage: - TeeworldsEconVPNDetectionGo add blacklist.txt [more-banlists.txt...] [flags] + TeeworldsEconVPNDetection add blacklist.txt [more-banlists.txt...] [flags] Flags: -c, --config string .env config file path (or via env variable TWVPN_CONFIG) @@ -127,14 +127,14 @@ Flags: Remove ips from the database (whitelist) ```shell -$ ./TeeworldsEconVPNDetectionGo remove --help +$ ./TeeworldsEconVPNDetection remove --help Environment variables: TWVPN_REDIS_ADDRESS (default: "localhost:6379") TWVPN_REDIS_PASSWORD TWVPN_REDIS_DB_VPN (default: "15") Usage: - TeeworldsEconVPNDetectionGo remove whitelist.txt [more-whitelists.txt...] [flags] + TeeworldsEconVPNDetection remove whitelist.txt [more-whitelists.txt...] [flags] Flags: -c, --config string .env config file path (or via env variable TWVPN_CONFIG)