From b1ad29ea19752337b367c28d39b298908e5837f7 Mon Sep 17 00:00:00 2001 From: Oshrat Nir <45561829+Oshratn@users.noreply.github.com> Date: Thu, 29 Dec 2022 15:26:09 +0200 Subject: [PATCH] English and typos --- README.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 97dd62c..903d1e8 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ # Kubescape -Visual studio extension the utilize the power 💪 of [Kubescape](https://github.com/kubescape/kubescape) directly into your -favorite text editor. +The [Visual studio extension](https://www.armosec.io/blog/securing-ci-cd-pipelines-security-gates/?utm_source=github&utm_medium=repository) lets utilize the power 💪 of [Kubescape](https://github.com/kubescape/kubescape) directly in your favorite text editor. ## ✨ Features -### Scan yaml files and get analysis from Kubescape +### Scan YAML files and get analysis from Kubescape -Yaml files can be scanned using a commands. -You can access any of this extension commands by opening the Command Palette (Ctrl+Shift+P on Linux/Windows and Cmd+Shift+P on Mac), and then typing in the command name. +YAML files can be scanned using a command. +You can access any of this extension's commands by opening the Command Palette (Ctrl+Shift+P on Linux/Windows and Cmd+Shift+P on Mac), and then typing in the command name. -The default behavior also scans yaml files on save 💾. +The default behavior also scans YAML files on save 💾. -Scanning results are marked and can be found in `vscode` 'PROBLEMS' tab. There is also a hover info that can be viewed on marked positions. +Scanning results are marked and can be found in `vscode` 'PROBLEMS' tab. Some inofrmation can be viewed when hovering over marked positions. ![yaml-demo](./images/yaml-demo.gif) @@ -25,19 +24,19 @@ However, it is recommended to have Kubescape installed in your path. Currently the following options can be configured: -### Set custom directory for kubescape +### Set custom directory for Kubescape -By default, this extension uses it's own kubescape binary in order to provide -a stable experience as it can. +By default, this extension uses it's own Kubescape binary in order to provide +as stable an experience as it can. -If, however, you desire to use a different or maybe a custom kubescape executable -you can use the option `Dir Path` which a custom directory on your system. +If, however, you desire to use a different or maybe a custom Kubescape executable +you can use the option `Dir Path` whith a custom directory on your system. ### Scan triggers -As for now, kubescape scan can take a while, so it might be unwise to run scans +For the time being, Kubescape scans can take a while, so it might be unwise to run scans without a good reason (like a dirty file). -I chose to do a background scan only when a new file is saved on the disk. +I chose to run a background scan only when a new file is saved on the disk. To choose between available files to scan on save use the option `Scan On Save`. @@ -45,45 +44,44 @@ Default : scan on save for all supported files. ### Frameworks -Frameworks are collections of controls. -There are some builtin controls that kubescape can use by default and can be +[Frameworks](https://www.armosec.io/blog/kubernetes-security-frameworks-and-guidance/?utm_source=github&utm_medium=repository) are collections of controls. +There are some built-in controls that Kubescape can use by default and can be downloaded locally for an offline scan. -Kubescape extension for vscode is using this method to increase it's scanning +The Kubescape extension for VS code uses this method to increase it's scanning speed. #### Choosing required frameworks -One can choose which frameworks are necessary by adding their names into the -`Required Frameworks` configuration. This list only ensure that the frameworks -in it will be downloaded - it's not marking them for scaning usage. +You can choose which frameworks used by adding their names into the +`Required Frameworks` configuration. This list only ensures that the frameworks +in it will be downloaded. It does not mark them for scanning usage. -Default : Empty. Meaning all available framework will be downloaded. +Default : Empty. Meaning all available frameworks will be downloaded. -#### Overriding framework directory +#### Overriding the framework directory -The used frameworks are getting downloaded to kubescape directory by default. -One can simply copy / download to this directory any desired framework. -Alternatively, you can use `Custom Frameworks Dir` configuration to choose a +The used frameworks are downloaded to the Kubescape directory by default. +You can simply copy / download any desired framework to this directory. +Alternatively, you can use the `Custom Frameworks Dir` configuration to choose a different directory for frameworks. -Default: Not set. Use kubescape binary directory. +Default: Not set. Uses the Kubescape binary directory. #### Specify frameworks for scanning -To specify which framework to use for scanning you can list them in the +To specify which frameworks to use for scanning you can list them in the `Scan Frameworks` configuration. -Those frameworks will be used at the moment of a scan. If not exists - they will +The specified frameworks will be used for the scan. If they dont exist, they will be downloaded automatically. -Default: Not set. Use frameworks from the framework directory. +Default: Not set. Uses frameworks from the framework directory. ### Kubescape Version -By default, I use a version of kubescape which is teseted more against integration -with this extension. +By default, I use a version of Kubescape that works well with this extension. -If, however, one wishes to use the latest and greatest it can be configured via +If, however, you wish to use the latest and greatest it can be configured via the `Version Tier` option by setting it to 'latest' ![kubescape-config](./images/kubescape-config.png)