Skip to content

Commit

Permalink
feat: 文档调整
Browse files Browse the repository at this point in the history
  • Loading branch information
dapeng committed Nov 24, 2024
1 parent a8b7acc commit 9b46afa
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 32 deletions.
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![Release](https://img.shields.io/github/release/gone-io/gone.svg?style=flat-square)](https://github.com/gone-io/gone/releases)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)

<img src="docs/assert/logo.png" width = "150" alt="logo" align=center />
<img src="docs/assert/logo.png" width = "100" alt="logo" align=center />


- [Gone](#gone)
Expand All @@ -30,25 +30,15 @@
# Gone
## What Is Gone?

Gone is a lightweight golang dependency injection framework; a series of Goners components are built in for rapid development of micro services.
Gone is a lightweight dependency injection framework for Golang, designed to integrate with a variety of third-party components, enabling rapid development of cloud-native microservices.

<img src="docs/assert/plan.png" width = "400" alt="plan"/>

## Features
- Define the Goner interface to abstract dependencies.
- Dependency Injection:
- Inject Goners.
- Inject function arguments.
- Modular, detachable design.
- Startup process control.
- Testing support.
- Built-in components:
- goner/config, supports dependency injection of configuration parameters.
- goner/tracer, adds TraceId to call chains, supports link tracing.
- goner/logrus, goner/zap, supports log recording.
- goner/gin, integrates with the gin framework to provide HTTP request parameter dependency injection.
- goner/viper, used to parse various configuration files.
- ...
- Dependency injection: Supports automatic injection of struct fields and function parameters.
- **[Gonectr](https://github.com/gone-io/gonectr)**: Generates projects, auxiliary code, compiles, and starts the project.
- Unit testing solution: Mock testing based on interfaces.
- Multiple pluggable components: Supports cloud-native and microservices architectures.

## Quick Start
1. Install [gonectr](https://github.com/gone-io/gonectr) and [mockgen](https://github.com/uber-go/mock/tree/main)
Expand Down
23 changes: 7 additions & 16 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![Release](https://img.shields.io/github/release/gone-io/gone.svg?style=flat-square)](https://github.com/gone-io/gone/releases)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)

<img src="docs/assert/logo.png" width = "150" alt="logo" />
<img src="docs/assert/logo.png" width = "100" alt="logo" />

- [Gone](#gone)
- [Gone 是什么?](#gone-是什么)
Expand All @@ -27,25 +27,16 @@

# Gone
## Gone 是什么?
Gone 是一个轻量级的golang依赖注入框架;内置了一系列Goners组件用于快速开发微服务。

Gone 是一个轻量级的golang依赖注入框架,并且适配了一些列第三方组件用于快速开始编写一个云原生的微服务。

<img src="docs/assert/plan.png" width = "400" alt="plan"/>

## 特性
- 定义Goner接口,对依赖进行抽象
- 依赖注入
- 注入Goners
- 注入函数参数
- 模块化,可拆卸设计
- 启动流程控制
- 测试支持
- 内置组件
- goner/config,支持配置参数的依赖注入
- goner/tracer,给调用链路增加TraceId,支持链路追踪
- goner/logrus、goner/zap,支持日志记录
- goner/gin,集成gin框架,提供HTTP请求参数的依赖注入
- goner/viper,用于解析多种配置文件
- ...
- 依赖注入,支持对结构体属性和函数参数自动注入
- **[Gonectr](https://github.com/gone-io/gonectr)**,生成项目、生成辅助代码、编译和启动项目
- 单元测试方案,基于接口的mock测试
- 多种组件,可插拔,支持云原生、微服务

## 快速开始
1. 安装 [gonectr](https://github.com/gone-io/gonectr)[mockgen](https://github.com/uber-go/mock/tree/main)
Expand Down

0 comments on commit 9b46afa

Please sign in to comment.