Skip to content

Commit 6e48706

Browse files
committed
docs: add feature doc
1 parent 727aa4e commit 6e48706

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,20 @@
1010

1111
# Kod
1212

13-
1413
Kod stands for **Killer Of Dependency**, a generics based dependency injection toolkit for Go.
1514

15+
## Feature
16+
17+
- **Component Based**: Kod is a component-based framework. Components are the building blocks of a Kod application.
18+
- **Configurable**: Kod can use TOML/YAML/JSON files to configure how applications are run.
19+
- **Testing**: Kod includes a Test function that you can use to test your Kod applications.
20+
- **Logging**: Kod provides a logging API, kod.L. Kod also integrates the logs into the environment where your application is deployed.
21+
- **OpenTelemetry**: Kod relies on OpenTelemetry to collect trace and metrics from your application.
22+
- **Hooks**: Kod provides a way to run code when a component start or stop.
23+
- **Interceptors**: Kod has built-in common interceptors, and components can implement the following methods to inject these interceptors into component methods.
24+
- **Interface Generation**: Kod provides a way to generate interface from structure.
25+
- **Code Generation**: Kod provides a way to generate kod related codes for your kod application.
26+
1627
## Installation
1728

1829
```bash

README_CN.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@
1212

1313
Kod代表“依赖杀手”,是基于泛型的Go语言依赖注入工具。
1414

15+
## 功能
16+
17+
- **基于组件**: Kod 是一个基于组件的框架。组件是 Kod 应用程序的构建模块。
18+
- **可配置的**: Kod 可以使用 TOML/YAML/JSON 文件来配置应用程序的运行方式。
19+
- **测试**: Kod 包含一个 Test 函数,您可以使用它来测试您的 Kod 应用程序。
20+
- **日志记录**: Kod 提供了一个日志记录 API,kod.L。Kod 还将日志集成到部署您的应用程序的环境- 中。
21+
- **OpenTelemetry**: Kod 依赖于 OpenTelemetry 来收集应用程序的跟踪和指标。
22+
- **钩子**: Kod 提供了一种在组件启动或停止时运行代码的方式。
23+
- **拦截器**: Kod 内置了常见的拦截器,组件可以实现以下方法来将这些拦截器注入到组件方法中。
24+
- **接口生成**: Kod 提供了一种从结构体生成接口的方法。
25+
- **代码生成**: Kod 提供了一种为您的 Kod 应用程序生成与 kod 相关代码的方法。
26+
1527
## 安装
1628
```bash
1729
go install github.com/go-kod/kod/cmd/kod@latest

0 commit comments

Comments
 (0)