Skip to content

Commit

Permalink
docs: add artifact hub module link and use the latest installation do…
Browse files Browse the repository at this point in the history
…cuments

Signed-off-by: peefy <[email protected]>
  • Loading branch information
Peefy committed Nov 12, 2023
1 parent cb4c687 commit f6ed620
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
10 changes: 4 additions & 6 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ KCL 是一个开源的基于约束的记录及函数语言并通过成熟的编
## 特性

+ **简单易用**:源于 Python、Golang 等高级语言,采纳函数式编程语言特性,低副作用
+ **设计良好**独立的 Spec 驱动的语法、语义、运行时和系统库设计
+ **快速建模** [Schema](https://kcl-lang.io/docs/reference/lang/tour#schema) 为中心的配置类型及模块化抽象
+ **设计良好**独立的规范驱动的语法、语义、运行时和系统库设计
+ **快速建模**[开箱即用的模型库](https://artifacthub.io/packages/search?org=kcl&sort=relevance&page=1)和以 [Schema](https://kcl-lang.io/docs/reference/lang/tour#schema) 为中心的配置类型及模块化抽象
+ **功能完备**:基于 [Config](https://kcl-lang.io/docs/reference/lang/tour#config-operations)[Schema](https://kcl-lang.io/docs/reference/lang/tour#schema)[Lambda](https://kcl-lang.io/docs/reference/lang/tour#function)[Rule](https://kcl-lang.io/docs/reference/lang/tour#rule) 的配置及其模型、逻辑和策略编写
+ **可靠稳定**:依赖[静态类型系统](https://kcl-lang.io/docs/reference/lang/tour/#type-system)[约束](https://kcl-lang.io/docs/reference/lang/tour/#validation)[自定义规则](https://kcl-lang.io/docs/reference/lang/tour#rule)的配置稳定性
+ **强可扩展**:通过独立配置块[自动合并机制](https://kcl-lang.io/docs/reference/lang/tour/#-operators-1)保证配置编写的高可扩展性
Expand All @@ -64,13 +64,11 @@ KCL 是一个开源的基于约束的记录及函数语言并通过成熟的编

## 安装

从 Github releases 页面[下载](https://github.com/kcl-lang/kcl/releases),并且将 `{install-location}/kclvm/bin` 添加到您的环境变量中

> 有关安装的更多信息,请查看 KCL 官网的[安装指南](https://kcl-lang.io/docs/user_docs/getting-started/install/)
有关安装的更多信息,请查看 KCL 官网的[安装指南](https://kcl-lang.io/docs/user_docs/getting-started/install/)

## 快速开始

`./samples/kubernetes.k` 是一个生成 kubernetes 资源的例子
`./samples/kubernetes.k` 是一个生成 Kubernetes 资源的例子

```python
apiVersion = "apps/v1"
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ You can use KCL to

## Features

+ **Easy-to-use**: Originated from high-level languages ​​such as Python and Golang, incorporating functional language features with low side-effects.
+ **Easy-to-use**: Originated from high-level languages ​​such as Python and Golang, incorporating functional language features with low side effects.
+ **Well-designed**: Independent spec-driven syntax, semantics, runtime and system modules design.
+ **Quick modeling**: [Schema](https://kcl-lang.io/docs/reference/lang/tour#schema)-centric configuration types and modular abstraction.
+ **Quick modeling**: [Out-of-the-box modules](https://artifacthub.io/packages/search?org=kcl&sort=relevance&page=1) and [Schema](https://kcl-lang.io/docs/reference/lang/tour#schema)-centric configuration types and modular abstraction.
+ **Rich capabilities**: Configuration with type, logic and policy based on [Config](https://kcl-lang.io/docs/reference/lang/tour#config-operations), [Schema](https://kcl-lang.io/docs/reference/lang/tour#schema), [Lambda](https://kcl-lang.io/docs/reference/lang/tour#function), [Rule](https://kcl-lang.io/docs/reference/lang/tour#rule).
+ **Stability**: Configuration stability is achieved through a [static type system](https://kcl-lang.io/docs/reference/lang/tour/#type-system), [constraints](https://kcl-lang.io/docs/reference/lang/tour/#validation), and [rules](https://kcl-lang.io/docs/reference/lang/tour#rule).
+ **Scalability**: High scalability is assured with an [automatic merge mechanism](https://kcl-lang.io/docs/reference/lang/tour/#-operators-1) of isolated config blocks.
Expand All @@ -63,13 +63,11 @@ A detailed feature and scenario comparison is [here](https://kcl-lang.io/docs/us

## Installation

[Download](https://github.com/kcl-lang/kcl/releases) the latest release from GitHub and add `{install-location}/kclvm/bin` to the environment `PATH`.

> For more information about installation, please check the [Installation Guide](https://kcl-lang.io/docs/user_docs/getting-started/install/) on the KCL official website.
For more information about installation, please check the [Installation Guide](https://kcl-lang.io/docs/user_docs/getting-started/install/) on the KCL official website.

## Showcase

`./samples/kubernetes.k` is an example of generating kubernetes manifests.
`./samples/kubernetes.k` is an example of generating Kubernetes manifests.

```python
apiVersion = "apps/v1"
Expand Down

0 comments on commit f6ed620

Please sign in to comment.