Skip to content

Commit 409d633

Browse files
committed
Update README.md and assets
Signed-off-by: Eric Zhao <sczyh16@gmail.com>
1 parent cda4f7e commit 409d633

5 files changed

Lines changed: 20 additions & 18 deletions

File tree

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
## Introduction
1212

1313
As distributed systems become increasingly popular, the reliability between services is becoming more important than ever before.
14-
Sentinel takes "flow" as breakthrough point, and works on multiple fields including **flow control**, **circuit breaking** and **system adaptive protection**, to guarantee service reliability.
14+
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.
1515

1616
Sentinel has the following features:
1717

@@ -20,15 +20,23 @@ Sentinel has the following features:
2020
- **Widespread open-source ecosystem**: Sentinel provides out-of-box integrations with commonly-used frameworks and libraries such as Spring Cloud, Dubbo and gRPC. You can easily use Sentinel by simply add the adapter dependency to your services.
2121
- **Various SPI extensions**: Sentinel provides easy-to-use SPI extension interfaces that allow you to quickly customize your logic, for example, custom rule management, adapting data sources, and so on.
2222

23+
Features overview:
24+
25+
![features-of-sentinel](./doc/image/sentinel-features-overview-en.png)
26+
2327
## Documentation
2428

25-
See the [中文文档](https://github.com/alibaba/Sentinel/wiki/%E4%BB%8B%E7%BB%8D) for Chinese readme.
29+
See the [中文文档](https://github.com/alibaba/Sentinel/wiki/%E4%BB%8B%E7%BB%8D) for document in Chinese.
2630

2731
See the [Wiki](https://github.com/alibaba/Sentinel/wiki) for full documentation, examples, blog posts, operational details and other information.
2832

2933
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.
3034
It's also encouraged to add the link of your blog post, tutorial, demo or customized components to [**Awesome Sentinel**](./doc/awesome-sentinel.md).
3135

36+
## Ecosystem Landscape
37+
38+
![ecosystem-landscape](./doc/image/sentinel-opensource-eco-landscape-en.png)
39+
3240
## Quick Start
3341

3442
Below is a simple demo that guides new users to use Sentinel in just 3 steps. It also shows how to monitor this demo using the dashboard.
@@ -37,37 +45,31 @@ Below is a simple demo that guides new users to use Sentinel in just 3 steps. It
3745

3846
**Note:** Sentinel requires Java 7 or later.
3947

40-
If your application is build in maven, just add the following code in pom.xml.
48+
If your application is build in Maven, just add the following dependency in `pom.xml`.
4149

4250
```xml
51+
<!-- replace here with the latest version -->
4352
<dependency>
4453
<groupId>com.alibaba.csp</groupId>
4554
<artifactId>sentinel-core</artifactId>
46-
<version>x.y.z</version>
55+
<version>1.5.0</version>
4756
</dependency>
4857
```
4958

5059
If not, you can download JAR in [Maven Center Repository](https://mvnrepository.com/artifact/com.alibaba.csp/sentinel-core).
5160

5261
### 2. Define Resource
5362

54-
Wrap code snippet via Sentinel API: `SphU.entry("resourceName")` and `entry.exit()`. In below example, it is `System.out.println("hello world");`:
63+
Wrap your code snippet via Sentinel API: `SphU.entry(resourceName)`.
64+
In below example, it is `System.out.println("hello world");`:
5565

5666
```java
57-
Entry entry = null;
58-
59-
try {
60-
entry = SphU.entry("HelloWorld");
61-
62-
// BIZ logic being protected
63-
System.out.println("hello world");
67+
try (Entry entry = SphU.entry("HelloWorld")) {
68+
// Your business logic here.
69+
System.out.println("hello world");
6470
} catch (BlockException e) {
65-
// handle block logic
66-
} finally {
67-
// make sure that the exit() logic is called
68-
if (entry != null) {
69-
entry.exit();
70-
}
71+
// Handle rejected request.
72+
e.printStackTrace();
7173
}
7274
```
7375

doc/image.gif

-28.1 KB
Binary file not shown.

doc/image/nolockcirclearray.gif

-19.4 KB
Binary file not shown.
134 KB
Loading
558 KB
Loading

0 commit comments

Comments
 (0)