Skip to content
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): readme improvements #7084

Merged
merged 42 commits into from
May 29, 2024
Merged
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
b6e6237
centered kics logo
JulioSCX May 28, 2024
2c7ac95
centered supported platforms
JulioSCX May 28, 2024
64241fa
Merge branch 'master' of https://github.com/Checkmarx/kics
JulioSCX May 28, 2024
c618fa2
added hyperlinks to supported platforms
JulioSCX May 28, 2024
c24bc64
added better spacing to platforms
JulioSCX May 28, 2024
3f75195
improved spacing between supported platforms
JulioSCX May 28, 2024
fc98115
test
JulioSCX May 28, 2024
eaffef2
test
JulioSCX May 28, 2024
23120da
test
JulioSCX May 28, 2024
2be77e7
reverting tests
JulioSCX May 28, 2024
264af38
fixed beta features icons
JulioSCX May 28, 2024
00d6440
test
JulioSCX May 28, 2024
0f0e2fb
test background
JulioSCX May 28, 2024
ce35ef3
test background
JulioSCX May 28, 2024
9ca6611
test background
JulioSCX May 28, 2024
d63ab19
test background
JulioSCX May 28, 2024
8d3dd33
background test
JulioSCX May 28, 2024
d8c48bd
border test
JulioSCX May 28, 2024
3b67abc
border test
JulioSCX May 28, 2024
286103e
size test
JulioSCX May 28, 2024
e232897
image background test
JulioSCX May 28, 2024
d8c2850
background color test
JulioSCX May 28, 2024
c405110
revert background test
JulioSCX May 28, 2024
123261f
table test
JulioSCX May 28, 2024
64327b9
table test
JulioSCX May 28, 2024
6def601
fix table test
JulioSCX May 28, 2024
59284c6
align table
JulioSCX May 28, 2024
d971f43
table test
JulioSCX May 28, 2024
96ba102
added less space between supported platforms
JulioSCX May 28, 2024
708b84c
less space between rows
JulioSCX May 28, 2024
dba9da3
changed spacing between icons
JulioSCX May 28, 2024
616ec7e
comparison test
JulioSCX May 28, 2024
f879853
added button-type test
JulioSCX May 28, 2024
6c32a26
centered button type test
JulioSCX May 28, 2024
4842424
added spacing between icons
JulioSCX May 28, 2024
ddcba6e
added spacing between icon rows
JulioSCX May 28, 2024
8cda7cb
removed button styles
JulioSCX May 28, 2024
4488586
fixed underline in images
JulioSCX May 28, 2024
6f8eaba
removed underlines
JulioSCX May 28, 2024
a4aee2c
Merge branch 'master' into readme-improvements
JulioSCX May 28, 2024
447168a
Merge branch 'master' into readme-improvements
gabriel-cx May 28, 2024
6129877
Merge branch 'master' into readme-improvements
gabriel-cx May 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 123 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/Checkmarx/kics)](https://goreportcard.com/report/github.com/Checkmarx/kics)
[![Go Coverage](https://raw.githubusercontent.com/Checkmarx/kics/gh-pages/coverage.svg)](https://docs.kics.io/coverage.html)


<p align="center">
<img alt="KICS - Keep Infrastructure as Code Secure" src="docs/img/logo/kics_new_logo_2022_dark.png#gh-light-mode-only" width="500">
<img alt="KICS - Keep Infrastructure as Code Secure" src="docs/img/logo/kics_new_logo_2022_white.png#gh-dark-mode-only" width="500">
</p>

---

Expand All @@ -24,43 +25,129 @@ Find security vulnerabilities, compliance issues, and infrastructure misconfigur

**KICS** stands for **K**eeping **I**nfrastructure as **C**ode **S**ecure, it is open source and is a must-have for any cloud native project.

#### Supported Platforms
### Supported Platforms

<img alt="Terraform" src="docs/img/logo-terraform.png" width="100" >&nbsp;&nbsp;&nbsp;
<img alt="Kubernetes" src="docs/img/logo-k8s.png" width="150">&nbsp;&nbsp;&nbsp;
<img alt="Docker" src="docs/img/logo-docker.png" width="150">&nbsp;&nbsp;&nbsp;
<br>
<br>
<img alt="CloudFormation" src="docs/img/logo-cf.png" width="150">&nbsp;&nbsp;&nbsp;
<img alt="Ansible" src="docs/img/logo-ansible.png" width="150">&nbsp;&nbsp;&nbsp;
<img alt="Helm" src="docs/img/logo-helm.png" width="150">&nbsp;&nbsp;&nbsp;
<br>
<br>
<img alt="OpenAPI" src="docs/img/logo-openapi.png" width="150">&nbsp;&nbsp;&nbsp;
<img alt="gRPC" src="docs/img/logo-grpc.png" width="120">&nbsp;&nbsp;&nbsp;
<img alt="Azure Resource Manager" src="docs/img/logo-arm.png" width="55">&nbsp;&nbsp;&nbsp;
<img alt="Google Deployment Manager" src="docs/img/logo-gdm.png" width="55">&nbsp;&nbsp;&nbsp;
<br>
<br>
<img alt="Cloud Deployment Kit" src="docs/img/logo-cdk.png" width="150">&nbsp;&nbsp;&nbsp;
<img alt="SAM" src="docs/img/logo-sam.png" width="55">&nbsp;&nbsp;&nbsp;
<img alt="Docker Compose" src="docs/img/logo-dockercompose.png" width="80">&nbsp;&nbsp;&nbsp;
<img alt="Knative" src="docs/img/logo-knative.png" width="80">&nbsp;&nbsp;&nbsp;
<br>
<br>
<img alt="Crossplane" src="docs/img/logo-crossplane.png" width="150">&nbsp;&nbsp;&nbsp;
<img alt="Pulumi" src="docs/img/logo-pulumi.png" width="130">&nbsp;&nbsp;&nbsp;
<img alt="ServerlessFW" src="docs/img/logo-serverlessfw.png" width="150">&nbsp;&nbsp;&nbsp;
<br>
<br>
<img alt="Azure BluePrints" src="docs/img/logo-azure-blueprints.png" width="100">&nbsp;&nbsp;&nbsp;
<img alt="GitHub Workflows" src="docs/img/logo-github-icon.png" width="100">&nbsp;&nbsp;&nbsp;
<img alt="OpenTofu" src="docs/img/logo-opentofu.png" width="150">&nbsp;&nbsp;&nbsp;

#### Beta Features
<img alt="Databricks" src="docs/img/logo-databricks.png" width="200">&nbsp;&nbsp;&nbsp;
<img alt="NIFCloud" src="docs/img/logo-nifcloud.png" width="110">&nbsp;&nbsp;&nbsp;
<img alt="TencentCloud" src="docs/img/logo-tencentcloud.png" width="180">&nbsp;&nbsp;&nbsp;
<table align="center"><tr>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#terraform" title="www.kics.io">
<img src="docs/img/logo-terraform.png" alt="Terraform" width="120" />
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#kubernetes" title="www.kics.io">
<img alt="Kubernetes" src="docs/img/logo-k8s.png" width="160">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#docker" title="www.kics.io">
<img alt="Docker" src="docs/img/logo-docker.png" width="180">
</a>
</td>
</tr></table>
<table align="center"><tr>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#cloudformation" title="www.kics.io">
<img alt="CloudFormation" src="docs/img/logo-cf.png" width="150">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#ansible" title="www.kics.io">
<img alt="Ansible" src="docs/img/logo-ansible.png" width="150">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#helm" title="www.kics.io">
<img alt="Helm" src="docs/img/logo-helm.png" width="150">
</a>
</td>
</tr></table>
<table align="center"><tr>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#openapi" title="www.kics.io">
<img alt="OpenAPI" src="docs/img/logo-openapi.png" width="175">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#grpc" title="www.kics.io">
<img alt="gRPC" src="docs/img/logo-grpc.png" width="120">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#azure-resource-manager" title="www.kics.io">
<img alt="Azure Resource Manager" src="docs/img/logo-arm.png" width="60">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#google-deployment-manager" title="www.kics.io">
<img alt="Google Deployment Manager" src="docs/img/logo-gdm.png" width="60">
</a>
</td>
</tr></table>
<table align="center"><tr>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#cdk" title="www.kics.io">
<img alt="Cloud Development Kit" src="docs/img/logo-cdk.png" width="160">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#sam" title="www.kics.io">
<img alt="SAM" src="docs/img/logo-sam.png" width="55">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#docker-compose" title="www.kics.io">
<img alt="Docker Compose" src="docs/img/logo-dockercompose.png" width="90">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#knative" title="www.kics.io">
<img alt="Knative" src="docs/img/logo-knative.png" width="80">
</a>
</td>
</tr></table>
<table align="center"><tr>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#crossplane" title="www.kics.io">
<img alt="Crossplane" src="docs/img/logo-crossplane.png" width="150">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#pulumi" title="www.kics.io">
<img alt="Pulumi" src="docs/img/logo-pulumi.png" width="130">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#serverlessfw" title="www.kics.io">
<img alt="ServerlessFW" src="docs/img/logo-serverlessfw.png" width="150">
</a>
</td>
</tr></table>
<table align="center"><tr>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#azure-blueprints" title="www.kics.io">
<img alt="Azure BluePrints" src="docs/img/logo-azure-blueprints.png" width="100">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#cicd" title="www.kics.io">
<img alt="GitHub Workflows" src="docs/img/logo-github-icon.png" width="100">
</a>
</td>
<td>
<a href="https://github.com/Checkmarx/kics/blob/master/docs/platforms.md#terraform" title="www.kics.io">
<img alt="OpenTofu" src="docs/img/logo-opentofu.png" width="150">
</a>
</td>
</tr></table>

### Beta Features
<p align="center">
<img alt="Databricks" src="docs/img/logo-databricks.png" width="200">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img alt="NIFCloud" src="docs/img/logo-nifcloud.png" width="110">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img alt="TencentCloud" src="docs/img/logo-tencentcloud.png" width="180">
&nbsp;&nbsp;&nbsp;
</p>

In order to run the Databricks, NIFCloud and TencentCloud queries, use the `--experimental-queries` flag when running KICS.

Expand Down
Loading