added error check and run instructions

readme.md

@@ -2,3 +2,10 @@
 
 Scan GitLab job output logs for secrets
 
+# Get Started
+
+Download the binary from the [Releases](https://github.com/CompassSecurity/pipeleak/releases) page.
+
+```bash
+pipeleak scan --token glpat-xxxxxxxxxxx --gitlab https://gitlab.com -v
+```

src/pipeleak/cmd/scan.go

@@ -30,7 +30,7 @@ func NewScanCmd() *cobra.Command {
 	}
 
 	scanCmd.Flags().StringVarP(&gitlabApiToken, "token", "t", "", "GitLab API Token")
-	scanCmd.MarkFlagRequired("token")
+	err = scanCmd.MarkFlagRequired("token")
 	if err != nil {
 		log.Error().Msg("Unable to require token flag: " + err.Error())
 	}