diff --git a/README.md b/README.md index 394a6e11e..584533532 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Apache SkyWalking Sky Walking logo -**SkyWalking**: APM (application performance monitor) tool for distributed systems, especially designed for +**SkyWalking**: APM (application performance monitor) tool for distributed systems, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures. [![GitHub stars](https://img.shields.io/github/stars/apache/incubator-skywalking.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/apache/incubator-skywalking) @@ -16,7 +16,7 @@ microservices, cloud native and container-based (Docker, Kubernetes, Mesos) arch [![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io) # Abstract -**SkyWalking** started as a distributed tracing system in 2015. From 5.x, it evolved to the fully functional [Application Performance Management](https://en.wikipedia.org/wiki/Application_performance_management) +**SkyWalking** started as a distributed tracing system in 2015. From 5.x, it evolved to the fully functional [Application Performance Management](https://en.wikipedia.org/wiki/Application_performance_management) system. It is used for tracing, monitoring, diagnose distributed systems, especially based on microservices, cloud native and container, including: - Distributed tracing and context propagation @@ -28,10 +28,10 @@ including: - Performance optimization # Core features -- Multiple languages instrumentation agent or libraries +- Multiple languages instrumentation agent or libraries - Native Java auto instrumentation agent. Trace and monitor your cluster without changing any source codes - Community instrumentation agent or libraries - * [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore) + * [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore) * [Node.js](https://github.com/OpenSkywalking/skywalking-nodejs) - Multiple storage backends: ElasticSearch, H2 - [OpenTracing](http://opentracing.io/) compatible @@ -39,11 +39,11 @@ including: - Lightweight and powerful backend aggregation and analysis capabilities - Modern and cool Web UI - Log integration -- Alarm for slow or unstable(low SLA) application, instance and service +- Alarm for slow or unstable(low SLA) application, instance and service - [**Incubating**] Support accepting other tracer data formats. - Zipkin JSON, Thrift, Protobuf v1 and v2 formats, powered by [OpenZipkin](https://github.com/openzipkin/zipkin) libs - Jaeger in [Zipkin Thrift or JSON v1/v2 formats](https://github.com/jaegertracing/jaeger#backwards-compatibility-with-zipkin) - + # Announcement After SkyWalking 5.0.0-beta2 released, all core features have been provided. For 5 series, we are trying to make them stable from now. At the same time, we have already begun our works for 6 series, in branch `6.0`. It will be a long way to have the first alpha release for it. So if you want to take part in the challengeable works, welcome, but don't consider to use that. Please read the [6.0 documents](https://github.com/apache/incubator-skywalking/blob/6.0/docs/README.md) first. @@ -77,14 +77,14 @@ Follow this [document](https://github.com/apache/incubator-skywalking/blob/maste * [Gitter](https://gitter.im/openskywalking/Lobby) * QQ Group: 392443393 -# Use cases +# Users -- [Use case list](docs/use-case-list.md) -- [Submit new use case to us.](https://github.com/apache/incubator-skywalking/issues/443) +- [Users list](docs/uses-list.md) +- [Submit new user to us.](https://github.com/apache/incubator-skywalking/issues/443)

- +
Our project enriches the OpenAPM Landscape!

diff --git a/README_ZH.md b/README_ZH.md index 74d97d6c9..b643bbeae 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -29,7 +29,7 @@ Apache SkyWalking | [English](README.md) - 多语言探针或类库 - Java自动探针，追踪和监控程序时，不需要修改源码。 - 社区提供的其他多语言探针 - * [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore) + * [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore) * [Node.js](https://github.com/OpenSkywalking/skywalking-nodejs) - 多种后端存储： ElasticSearch， H2 - 支持[OpenTracing](http://opentracing.io/) @@ -39,7 +39,7 @@ Apache SkyWalking | [English](README.md) - 日志集成 - 应用、实例和服务的告警 - [**Incubating**]支持接口其他探针的数据 - - 接受Zipkin v1 v2格式数据，采用JSON, Thrift, Protobuf序列化方式。Powered by [OpenZipkin](https://github.com/openzipkin/zipkin) libs + - 接受Zipkin v1 v2格式数据，采用JSON, Thrift, Protobuf序列化方式。Powered by [OpenZipkin](https://github.com/openzipkin/zipkin) libs - 接受Jaeger 使用 [Zipkin Thrift 或 JSON v1/v2 格式](https://github.com/jaegertracing/jaeger#backwards-compatibility-with-zipkin) # Document @@ -73,10 +73,10 @@ This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDU * [Gitter](https://gitter.im/openskywalking/Lobby) * QQ群: 392443393 -# Use cases +# Users -- [用户案例](docs/use-case-list.md) +- [用户案例](docs/users-list.md) - [报告新的用户案例](https://github.com/apache/incubator-skywalking/issues/443) diff --git a/docs/use-case-list.md b/docs/uses-list.md similarity index 100% rename from docs/use-case-list.md rename to docs/uses-list.md