Skip to content

Commit 37e88a4

Browse files
authored
doc: Update README.md
1 parent ddd2642 commit 37e88a4

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
# Sentinel: The Sentinel of Your Microservices
66

77
![CI](https://github.com/alibaba/sentinel-golang/workflows/CI/badge.svg?branch=master)
8-
[![Build Status](https://travis-ci.org/alibaba/sentinel-golang.svg?branch=master)](https://travis-ci.org/alibaba/sentinel-golang)
98
[![codecov](https://codecov.io/gh/alibaba/sentinel-golang/branch/master/graph/badge.svg)](https://codecov.io/gh/alibaba/sentinel-golang)
9+
[![GoDoc](https://pkg.go.dev/badge/github.com/alibaba/sentinel-golang)](https://pkg.go.dev/github.com/alibaba/sentinel-golang)
1010
[![Go Report Card](https://goreportcard.com/badge/github.com/alibaba/sentinel-golang)](https://goreportcard.com/report/github.com/alibaba/sentinel-golang)
1111
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
1212
[![Gitter](https://badges.gitter.im/alibaba/Sentinel.svg)](https://gitter.im/alibaba/Sentinel)
@@ -17,20 +17,21 @@
1717
## Introduction
1818

1919
As distributed systems become increasingly popular, the reliability between services is becoming more important than ever before.
20-
Sentinel takes "flow" as breakthrough point, and works on multiple fields including **flow control**,
21-
**circuit breaking** and **system adaptive protection**, to guarantee reliability and resiliency of microservices.
20+
Sentinel takes "flow" as breakthrough point, and works on multiple fields including **flow control**, **traffic shaping**, **concurrency limiting**, **circuit breaking** and **system adaptive overload protection**, to guarantee reliability and resiliency of microservices.
2221

2322
![flow-overview](https://raw.githubusercontent.com/sentinel-group/sentinel-website/master/img/sentinel-flow-index-overview-en.jpg)
2423

2524
Sentinel provides the following features:
2625

2726
- **Rich applicable scenarios**: Sentinel has been wildly used in Alibaba, and has covered almost all the core-scenarios in Double-11 (11.11) Shopping Festivals in the past 10 years, such as “Second Kill” which needs to limit burst flow traffic to meet the system capacity, throttling, circuit breaking for unreliable downstream services, distributed rate limiting, etc.
2827
- **Real-time monitoring**: Sentinel also provides real-time monitoring ability. You can see the runtime information of a single machine in real-time, and pump the metrics to outside metric components like Prometheus.
29-
- **Cloud-native ecosystem**: Sentinel Go provides out-of-box integrations with cloud-native components.
28+
- **Cloud-native ecosystem**: Sentinel Go provides [out-of-box integrations with cloud-native components](https://sentinelguard.io/en-us/docs/golang/open-source-framework-integrations.html).
3029

3130
## Documentation
3231

33-
See the [中文文档](https://sentinelguard.io/zh-cn/docs/golang/basic-api-usage.html) for document in Chinese.
32+
[![GoDoc](https://pkg.go.dev/badge/github.com/alibaba/sentinel-golang)](https://pkg.go.dev/github.com/alibaba/sentinel-golang)
33+
34+
See the [中文文档](https://sentinelguard.io/zh-cn/docs/golang/basic-api-usage.html) for the document in Chinese.
3435

3536
See the [Wiki](https://github.com/alibaba/sentinel-golang/wiki) for full documentation, examples, blog posts, and other information.
3637

@@ -39,11 +40,8 @@ It's also encouraged to add the link of your blog post, tutorial, demo or custom
3940

4041
## Sub-projects
4142

42-
All integration modules and sub-projects are located in [sentinel-group](https://github.com/sentinel-group).
43-
44-
- [Sentinel Go adapters for frameworks](https://github.com/sentinel-group/sentinel-go-adapters)
45-
- [Sentinel Go dynamic data-source modules](https://github.com/sentinel-group/sentinel-go-datasources)
46-
- [Kubernetes CRD data-source for Sentinel Go](https://github.com/sentinel-group/sentinel-go-datasource-k8s-crd)
43+
- [Sentinel Go adapters for frameworks](https://sentinelguard.io/en-us/docs/golang/open-source-framework-integrations.html)
44+
- [Sentinel Go dynamic data-source modules](https://sentinelguard.io/en-us/docs/golang/dynamic-data-source-usage.html)
4745

4846
## Bugs and Feedback
4947

0 commit comments

Comments
 (0)