add section 0.1.0 to CHANGELOG

update README

CHANGELOG.md

@@ -11,6 +11,12 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+# [0.1.0] - 2024-11-29
+
+### Changed
+
+-   `-P` flag changed to `-r` for setting rcon password. This is to disambiguate it from the port (-p) flag.
+
 # [0.0.3] - 2024-11-24
 
 ### Changed

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Onyx and Iris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -93,15 +93,15 @@ rcon, err := q3rcon.New(
 
 ## Command line
 
-Pass `host`, `port` and `password` as flags, for example:
+Pass `host`, `port` and `rconpass` as flags, for example:
 
 ```
-q3rcon -h=localhost -p=30000 -P="rconpassword" "mapname"
+q3rcon -h=localhost -p=30000 -r="rconpassword" "mapname"
 ```
 
 -   `host` defaults to "localhost"
 -   `port` defaults to 28960
--   `password` defaults to ""
+-   `rconpass` defaults to ""
 
 Arguments following the flags will be sent as rcon commands. You may send multiple arguments.
 
@@ -110,7 +110,7 @@ Arguments following the flags will be sent as rcon commands. You may send multip
 Pass `interactive (-i shorthand)` flag to enable interactive mode, for example:
 
 ```
-q3rcon -h=localhost -p=30000 -P="rconpassword" -i
+q3rcon -h=localhost -p=30000 -r="rconpassword" -i
 ```
 
 If interactive mode is enabled, any arguments sent on the command line will be ignored.

cmd/q3rcon/main.go

@@ -27,7 +27,7 @@ func main() {
 	var (
 		host     string
 		port     int
-		password string
+		rconpass string
 		loglevel int
 	)
 
@@ -35,8 +35,8 @@ func main() {
 	flag.StringVar(&host, "h", "localhost", "hostname of the server (shorthand)")
 	flag.IntVar(&port, "port", 28960, "port of the server")
 	flag.IntVar(&port, "p", 28960, "port of the server (shorthand)")
-	flag.StringVar(&password, "password", "", "rcon password")
+	flag.StringVar(&rconpass, "rconpass", "", "rcon password")
-	flag.StringVar(&password, "P", "", "rcon password (shorthand)")
+	flag.StringVar(&rconpass, "r", "", "rcon password (shorthand)")
 
 	flag.BoolVar(&interactive, "interactive", false, "run in interactive mode")
 	flag.BoolVar(&interactive, "i", false, "run in interactive mode")
@@ -49,7 +49,7 @@ func main() {
 		log.SetLevel(log.Level(loglevel))
 	}
 
-	rcon, err := connectRcon(host, port, password)
+	rcon, err := connectRcon(host, port, rconpass)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -92,7 +92,7 @@ func interactiveMode(rcon *q3rcon.Rcon, input io.Reader) error {
 	scanner := bufio.NewScanner(input)
 	for scanner.Scan() {
 		cmd := scanner.Text()
-		if strings.ToUpper(cmd) == "Q" {
+		if strings.EqualFold(cmd, "Q") {
 			return nil
 		}