Improve readme and help output (#35)

.gitignore

@@ -11,11 +11,8 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-# Staged manifest files
-k8s-monitor-*.yaml
-
 # Ignore go mod vendor files for local type checking
 vendor/
 
 # Ignore test keys
-*.pem
+*.pem

README.md

@@ -130,3 +130,9 @@ exit status 1
 ```
 
 Other commands include `create`, `update`, `delete` and `list` which do pretty much what you'd expect with AWS Secret Manager secrets logically scoped to the user's k8s namespace. Check the relevant `-help` for more information.
+
+**Notes**
+* The `-token-path` is optional for all commands. Without it `kiss` will attempt to find the first file in the default `~/.kube/cache/oidc-login` directory
+* On a Mac you can't use the `~/` path when specifying the token path - instead use `$HOME/`
+* When you create a secret it will be base64 encoded, so you should specify it's value in plaintext
+* A secret name cannot contain underscores as this will result in the "Error occurred while creating secret" error

client/cmd/main.go

@@ -34,7 +34,7 @@ var (
 
 	createSecretCmd    = flag.NewFlagSet("create", flag.ExitOnError)
 	createSecretName   = createSecretCmd.String("name", "", "The name of the secret.")
-	createSecretValue  = createSecretCmd.String("value", "", "The value of the secret.")
+	createSecretValue  = createSecretCmd.String("value", "", "The plaintext value of the secret.")
 	createSecretPolicy = createSecretCmd.Bool(
 		"policy",
 		false,
@@ -188,7 +188,7 @@ func setupCommonFlags() {
 			&serverAddr,
 			"server-addr",
 			"localhost:10000",
-			"The monitor server address in the format of host:port",
+			"The kiss server address in the format of host:port",
 		)
 		fs.DurationVar(
 			&timeout, "timeout", 30*time.Second, "The interval before a connection times out",