-
Notifications
You must be signed in to change notification settings - Fork 94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md #50
Update README.md #50
Conversation
Fixed typos and grammatical errors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good overall. Two minor nitpicks.
README.md
Outdated
@@ -32,9 +32,9 @@ The scanner supports extracting and using the following types of credentials: | |||
* OAuth2 Refresh Token with cloud-platform scope granted; | |||
* GCP service account key in JSON format. | |||
|
|||
The scanner does not rely on any third-party tool (e.g. gcloud). Thus, it can be compiled as a standalone tool and be used on a machine with no GCP SDK installed (e.g. Kubernetes pod). However, please keep in mind that the only OS that is currently supported is Linux. | |||
The scanner does not rely on any third-party tool (e.g., Gcloud). Thus, it can be compiled as a standalone tool and used on a machine with no GCP SDK installed (e.g., a Kubernetes pod). However, please keep in mind that the only OS that is currently supported is Linux. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gcloud
is the name of the GCP CLI tool and should be kept lowercase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changed to gcloud
Updated the doc as per suggestion.
README.md
Outdated
@@ -32,9 +32,9 @@ The scanner supports extracting and using the following types of credentials: | |||
* OAuth2 Refresh Token with cloud-platform scope granted; | |||
* GCP service account key in JSON format. | |||
|
|||
The scanner does not rely on any third-party tool (e.g. gcloud). Thus, it can be compiled as a standalone tool and be used on a machine with no GCP SDK installed (e.g. Kubernetes pod). However, please keep in mind that the only OS that is currently supported is Linux. | |||
The scanner does not rely on any third-party tool (e.g., gcloud). Thus, it can be compiled as a standalone tool and used on a machine with no GCP SDK installed (e.g., a Kubernetes pod). However, please keep in mind that the only OS that is currently supported is Linux. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No commas after e.g.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ggold7046 please resolve this one so we can merge the PR.
Updated the doc as per suggestion.
README.md
Outdated
@@ -32,7 +32,7 @@ The scanner supports extracting and using the following types of credentials: | |||
* OAuth2 Refresh Token with cloud-platform scope granted; | |||
* GCP service account key in JSON format. | |||
|
|||
The scanner does not rely on any third-party tool (e.g., gcloud). Thus, it can be compiled as a standalone tool and used on a machine with no GCP SDK installed (e.g., a Kubernetes pod). However, please keep in mind that the only OS that is currently supported is Linux. | |||
The scanner does not rely on any third-party tool (e.g. gcloud). Thus, it can be compiled as a standalone tool and used on a machine with no GCP SDK installed (e.g., a Kubernetes pod). However, please keep in mind that the only OS that is currently supported is Linux. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is another comma after e.g.
Updated as per suggstion.
LGTM but please resolve the conflicting files before we can merge. |
I don't know how to resolve this conflict. Could you guide me please ? |
Fixed typos and grammatical errors.