Skip to content

Commit

Permalink
docs: refine readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Peefy committed Mar 28, 2023
1 parent 0a25afd commit 3da1aff
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# Helm KCL Plugin

[![Go Report Card](https://goreportcard.com/badge/github.com/KusionStack/helm-kcl)](https://goreportcard.com/report/github.com/KusionStack/helm-kcl)
[![GoDoc](https://godoc.org/github.com/KusionStack/helm-kcl?status.svg)](https://godoc.org/github.com/KusionStack/helm-kcl)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/KusionStack/helm-kcl/blob/main/LICENSE)

# Helm KCL Plugin
[KCL](https://github.com/KusionStack/KCLVM) is a constraint-based record & functional domain language. Full documents of KCL can be found [here](https://kcl-lang.io/).

You can use the Helm-KCL-Plugin to
You can use the `Helm-KCL-Plugin` to

+ Modify the `values.yaml` value of the helm charts you rely on by certain conditions or dynamically.
+ Edit the helm charts in a hook way to separate data and logic for the Kubernetes manifests management.
+ For multi-environment and multi-tenant scenarios, you can maintain these configurations gracefully rather than simply copy and paste.
+ Validate all KRM resources using the KCL schema.

## Introduction

[KCL](https://github.com/KusionStack/KCLVM) is a constraint-based record & functional domain language. Full documents of KCL can be found [here](https://kcl-lang.io/).

## Install

### Using Helm plugin manager (> 2.3.x)
Expand Down

0 comments on commit 3da1aff

Please sign in to comment.