From 71bd6ed7fc15c78e4a4a34f1d27282e734043cc8 Mon Sep 17 00:00:00 2001 From: Eric Zhao Date: Thu, 13 Feb 2020 12:01:05 +0800 Subject: [PATCH] Update README.md Signed-off-by: Eric Zhao --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2d548d94..95310ebf5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,32 @@ [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Gitter](https://badges.gitter.im/alibaba/Sentinel.svg)](https://gitter.im/alibaba/Sentinel) +## Introduction + +As distributed systems become increasingly popular, the reliability between services is becoming more important than ever before. +Sentinel takes "flow" as breakthrough point, and works on multiple fields including **flow control**, **circuit breaking** and **system adaptive protection**, to guarantee reliability of microservices. + +Sentinel has the following features: + +- **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, cluster flow control, etc. +- **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. +- **Cloud-native ecosystem**: Sentinel Golang provides out-of-box integrations with cloud-native components. + +## Documentation + +See the [中文文档](https://github.com/sentinel-group/sentinel-golang/wiki/介绍) for document in Chinese. + +See the [Wiki](https://github.com/sentinel-group/sentinel-golang/wiki) for full documentation, examples, blog posts, and other information. + +If you are using Sentinel, please [**leave a comment here**](https://github.com/alibaba/Sentinel/issues/18) to tell us your scenario to make Sentinel better. +It's also encouraged to add the link of your blog post, tutorial, demo or customized components to [**Awesome Sentinel**](https://github.com/sentinel-group/sentinel-awesome). + +## Bugs and Feedback + +For bug report, questions and discussions please submit [GitHub Issues](https://github.com/sentinel-group/sentinel-golang/issues). + ## Contributing -Contributions are always welcomed! Please see [CONTRIBUTING](./CONTRIBUTING.md) for detailed guidelines. \ No newline at end of file +Contributions are always welcomed! Please see [CONTRIBUTING](./CONTRIBUTING.md) for detailed guidelines. + +You can start with the issues labeled with [`good first issue`](https://github.com/sentinel-group/sentinel-golang/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). \ No newline at end of file