Skip to content

Commit

Permalink
fix: change readme QuickStart link
Browse files Browse the repository at this point in the history
  • Loading branch information
FangjieLiang committed Jan 22, 2022
1 parent 2b26fe6 commit 4f57ad6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
15 changes: 8 additions & 7 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
polaris-go
# polaris-go

========================================
北极星polaris是一个支持多种开发语言、兼容主流开发框架的服务治理中心。polaris-go是北极星的Go语言嵌入式服务治理SDK

## 概述

polaris-go提供以下功能特性:

* ** 服务实例注册,心跳上报
- 服务实例注册,心跳上报

提供API接口供应用上下线时注册/反注册自身实例信息,并且可通过定时上报心跳来通知主调方自身健康状态。

* ** 服务发现
- 服务发现

提供多种API接口,通过API接口,用户可以获取服务下的全量服务实例,或者获取通过服务治理规则过滤后的一个服务实例,可供业务获取实例后马上发起调用。

* ** 故障熔断
- 故障熔断

提供API接口供应用上报接口调用结果数据,并根据汇总数据快速对故障实例/分组进行隔离,以及在合适的时机进行探测恢复。

* ** 服务限流
- 服务限流

提供API接口供应用进行配额的检查及划扣,支持按服务级,以及接口级的限流策略。

Expand All @@ -28,13 +29,13 @@ polaris-go提供以下功能特性:

polaris-go通过go mod进行管理,用户可以在go.mod文件中引入polaris-go的依赖

```
```go
github.com/polarismesh/polaris-go v1.0.0
```

### 使用API

API的快速使用指南,可以参考:[QuickStart](sample/quickstart)
API的快速使用指南,可以参考:[QuickStart](examples/quickstart)

## License

Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
polaris-go
# polaris-go

========================================
Polaris is an operation centre that supports multiple programming languages, with high compatibility to different
application framework. Polaris-go is golang SDK for Polaris.
Expand All @@ -7,22 +8,22 @@ application framework. Polaris-go is golang SDK for Polaris.

Polaris-go provide features listed as below:

* ** Service instance registration, and health check
- Service instance registration, and health check

Provides API on/offline registration instance information, with regular report to inform caller server's healthy
status.

* ** Service discovery
- Service discovery

Provides multiple API, for users to get a full list of server instance, or get one server instance after route rule
filtering and loadbalancing, which can be applied to srevice invocation soon.

* ** Service circuitbreaking
- Service circuitbreaking

Provide API to report the invocation result, and conduct circuit breaker instance/group insolation based on collected
data, eventually recover when the system allows.

* ** Service ratelimiting
- Service ratelimiting

Provides API for applications to conduct quota check and deduction, supports rate limit policies that are based on
server level and port.
Expand All @@ -33,13 +34,13 @@ Polaris-go provide features listed as below:

polaris-go can be referenced by go mod, user can add dependency to go.mod file

```
```go
github.com/polarismesh/polaris-go v1.0.0
```

### Using API

API quick start guide,can reference:[QuickStart](sample/quickstart)
API quick start guide,can reference:[QuickStart](examples/quickstart)

## License

Expand Down

0 comments on commit 4f57ad6

Please sign in to comment.