Skip to content

Commit 081bbab

Browse files
authored
docs: add examples docs (#8)
* docs: add examples docs * docs: update examples README
1 parent f9b60d7 commit 081bbab

29 files changed

+1521
-111
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# polaris-php
22

3+
Polaris is an operation centre that supports multiple programming languages, with high compatibility to different
4+
application framework. Polaris-php is php SDK for Polaris.
35

4-
Polaris is an operation centre that supports multiple programming languages, with high compatibility to different application framework. Polaris-php is php SDK for Polaris.
6+
[中文文档](./README_ZH.md)
57

68
## Overview
79

@@ -27,12 +29,12 @@ Polaris-php provide features listed as below:
2729

2830
### Build Polaris-PHP
2931

30-
You can see this document to build polaris-php: [BuildDoc](doc/HowToBuild.md)
32+
You can see this document to build polaris-php: [BuildDoc](./doc/HowToBuild.md)
3133

3234
### Using API
3335

34-
API use guide,can reference:[ApiDoc](doc/ApiDoc.md)
36+
API use guide,can reference:[ApiDoc](./doc/ApiDoc.md)
3537

3638
### Example
3739

38-
API quick start guide,can reference:[QuickStart](example)
40+
API quick start guide,can reference:[QuickStart](./examples/quickstart)

README_ZH.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# polaris-php
2+
3+
北极星polaris是一个支持多种开发语言、兼容主流开发框架的服务治理中心。polaris-php 是北极星的PHP语言嵌入式服务治理SDK
4+
5+
[English Document](./README.md)
6+
7+
## 概述
8+
9+
polaris-php 提供以下功能特性:
10+
11+
* ** 服务实例注册,心跳上报
12+
13+
提供API接口供应用上下线时注册/反注册自身实例信息,并且可通过定时上报心跳来通知主调方自身健康状态。
14+
15+
* ** 服务发现
16+
17+
提供多种API接口,通过API接口,用户可以获取服务下的全量服务实例,或者获取通过服务治理规则过滤后的一个服务实例,可供业务获取实例后马上发起调用。
18+
19+
* ** 故障熔断
20+
21+
提供API接口供应用上报接口调用结果数据,并根据汇总数据快速对故障实例/分组进行隔离,以及在合适的时机进行探测恢复。
22+
23+
* ** 服务限流
24+
25+
提供API接口供应用进行配额的检查及划扣,支持按服务级,以及接口级的限流策略。
26+
27+
## 快速入门
28+
29+
### 构建Polaris-P
30+
31+
可以查看此文档来进行构建polaris-php插件: [BuildDoc](./doc/HowToBuild_ZH.md)
32+
33+
### Using API
34+
35+
API的使用文档:[ApiDoc](./doc/ApiDoc_ZH.md)
36+
37+
### Example
38+
39+
如何快速使用polaris-php:[QuickStart](./examples/quickstart)

0 commit comments

Comments
 (0)