From 49a733c86480548359001c35d91424e395e84cb1 Mon Sep 17 00:00:00 2001 From: Tony Date: Wed, 12 Jun 2019 00:27:51 +0800 Subject: [PATCH] Update README.md --- README.md | 46 ++++++++++++++++++++-------------------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index fa1269974..5dd1fa8c1 100644 --- a/README.md +++ b/README.md @@ -5,47 +5,42 @@ [![GoDoc](https://godoc.org/github.com/bilibili/kratos?status.svg)](https://godoc.org/github.com/bilibili/kratos) [![Go Report Card](https://goreportcard.com/badge/github.com/bilibili/kratos)](https://goreportcard.com/report/github.com/bilibili/kratos) -Kratos是[bilibili](https://www.bilibili.com)开源的一套Go微服务框架，包含大量微服务相关框架及工具： +# Kratos -- [HTTP框架: Blademaster(bm)](doc/wiki-cn/blademaster.md) +Kratos是bilibili开源的一套Go微服务框架，包含大量微服务相关框架及工具。 - 基于[gin](https://github.com/gin-gonic/gin)二次开发，具有快速、灵活的特点，可以方便的开发中间件处理通用或特殊逻辑，基础库默认实现了log&trace等。 - -- [gRPC框架: Warden(wd)](doc/wiki-cn/warden.md) +> 名字来源于:《战神》游戏以希腊神话为背景，讲述由凡人成为战神的奎托斯（Kratos）成为战神并展开弑神屠杀的冒险历程。 - 基于官方gRPC封装，默认使用[discovery](https://github.com/bilibili/discovery)进行服务注册发现，及wrr和p2c(默认)负载均衡。 - -- 基础组件库 +## Goals - * [dapper trace](doc/wiki-cn/dapper.md)：基于opentracing，全链路集成了trace，我们还提供dapper实现，请参看：[dapper敬请期待]()。 - - * [log](doc/wiki-cn/logger.md)：基于[zap](https://github.com/uber-go/zap)的field方式实现的高性能log库，集成了我们提供的[log-agent敬请期待]()日志收集方案。 - - * [cache](doc/wiki-cn/cache.md)：集成memcache&redis的SDK，注意无redis-cluster实现，推荐使用代理模式[overlord](https://github.com/bilibili/overlord)。 - - * [database](doc/wiki-cn/database.md)：集成MySQL&HBase&TiDB的SDK，其中TiDB使用服务发现方案。 +我们致力于提供完整的微服务研发体验，整合相关框架及工具后，微服务治理相关部分可对整体业务开发周期无感，从而更加聚焦于业务交付。对每位开发者而言，整套Kratos框架也是不错的学习仓库，可以了解和参考到bilibili在微服务方面的技术积累和经验。 -- 框架工具链 +## Features +* HTTP Blademaster：核心基于[gin](https://github.com/gin-gonic/gin)进行模块化设计，简单易用、核心足够轻量； +* GRPC Warden：基于官方gRPC开发，集成[discovery](https://github.com/bilibili/discovery)进行服务发现，并融合P2C负载均衡； +* Cache：优雅的接口化设计，非常方便的缓存序列化，推荐结合代理模式[overlord](https://github.com/bilibili/overlord)； +* Database：集成MySQL/HBase/TiDB，添加熔断保护和统计支持，可快速发现数据层压力； +* Config：方便易用的[paladin sdk](doc/wiki-cn/config.md)，可配合远程配置中心，实现配置版本管理和更新； +* Log：类似[zap](https://github.com/uber-go/zap)的field实现高性能日志库，并结合log-agent实现远程日志管理； +* Trace：基于opentracing，全链路集成了trace支持（gRPC/HTTP/MySQL/Redis/Memcached）； +* Kratos Tool：构架工具链，可快速生成标准项目，或者通过Protobuf生成代码，非常便捷使用gRPC、HTTP、swagger以及文档输出； - * [kratos tool](doc/wiki-cn/kratos-tool.md)：kratos相关工具量，包括项目快速生成、pb文件代码生成、swagger文档生成等。 - -我们致力于提供完整的微服务研发体验，整合相关框架及工具后，微服务治理相关部分可对整体业务开发周期无感，从而更加聚焦于业务交付。对每位开发者而言，整套Kratos框架也是不错的学习仓库，可以了解和参考到[bilibili](https://www.bilibili.com)在微服务方面的技术积累和经验。 - -*名字来源于:《[战神](https://baike.baidu.com/item/%E6%88%98%E7%A5%9E/5896427)》游戏以希腊神话为背景，讲述由凡人成为战神的奎托斯（Kratos）成为战神并展开弑神屠杀的冒险历程。* +## Quick start -## Requirments +### Requirments Go version>=1.12 and GO111MODULE=on -## Quick start - +### Installation ```shell go get -u github.com/bilibili/kratos/tool/kratos cd $GOPATH/src kratos new kratos-demo ``` -`kratos new`会快速生成基于kratos库的脚手架代码，如生成[kratos-demo](https://github.com/bilibili/kratos-demo) +通过 `kratos new` 会快速生成基于kratos库的脚手架代码，如生成 [kratos-demo](https://github.com/bilibili/kratos-demo) + +### Build & Run ```shell cd kratos-demo/cmd @@ -67,4 +62,3 @@ Kratos is under the MIT license. See the [LICENSE](./LICENSE) file for details. ------------- *Please report bugs, concerns, suggestions by issues, or join QQ-group 716486124 to discuss problems around source code.* -