Improve the docs for using GCP to clarify the project-ID and fix a broken command. (#291)

* Improve the docs for using GCP.

Signed-off-by: Caleb Brown <[email protected]>

* Improve the README.md files to help new users.

Signed-off-by: Caleb Brown <[email protected]>

* Update go.work.sum...

Signed-off-by: Caleb Brown <[email protected]>

---------

Signed-off-by: Caleb Brown <[email protected]>

Author: calebbrown

README.md

@@ -47,12 +47,13 @@ open source project:
 
 ## Usage
 
-The program only requires one argument to run, the name of the repo:
-
 ```shell
 $ go install github.com/ossf/criticality_score/cmd/criticality_score@latest
 
-$ criticality_score github.com/kubernetes/kubernetes
+$ export GITHUB_TOKEN=...         # requires a GitHub token to work
+$ gcloud auth login --update-adc  # optional, add -depsdev-disable to skip
+
+$ criticality_score -gcp-project-id=[your projectID] github.com/kubernetes/kubernetes
 repo.name: kubernetes
 repo.url: https://github.com/kubernetes/kubernetes
 repo.language: Go

cmd/criticality_score/README.md

@@ -9,11 +9,12 @@ The input of this tool could by the output of the `enumerate_github` tool.
 
 ```shell
 $ export GITHUB_TOKEN=ghp_x  # Personal Access Token Goes Here
-$ gcloud login --update-adc  # Sign-in to GCP
+$ gcloud auth login --update-adc  # Sign-in to GCP
 $ criticality_score \
     -workers=1 \
     -out=signals.csv \
     -format=csv \
+    -gcp-project-id=x \
     github_projects.txt
 ```
 
@@ -61,6 +62,9 @@ $ export GITHUB_TOKEN=ghp_abc,ghp_123
 
 #### GCP Authentication
 
+Google Cloud Platform authentication is required to collect dependent counts
+using deps.dev data. This can be skipped if `-depsdev-disable` is passed in.
+
 BigQuery access requires the "BigQuery User" (`roles/bigquery.user`) role added
 to the account used, or be an "Owner".
 
@@ -121,7 +125,9 @@ fail.
 
 #### Google Cloud Platform flags
 
-- `-gcp-project-id string` the Google Cloud Project ID to use. Auto-detects by default.
+- `-gcp-project-id string` the Google Cloud Project ID to use. Auto-detects by
+  default. If auto-detect fails an error containing the message "unable to
+  detect projectID" will be shown, and this flag will need to be set.
 
 #### deps.dev Collection Flags
 
@@ -229,4 +235,4 @@ Pass in a single repo to quickly test signal collection, for example:
 $ go run ./cmd/criticality_score \
     -log=debug \
     https://github.com/django/django
-```
+```