This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-kong.git


The following commit(s) were added to refs/heads/master by this push:
     new a6bce7e  polish docs (#1)
a6bce7e is described below

commit a6bce7ec7e30ca65c6bf82e7a9956eab8cb88173
Author: Daming <[email protected]>
AuthorDate: Sat Apr 17 22:43:52 2021 +0800

    polish docs (#1)
---
 README.md | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 1cb7c30..e6c1e67 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,20 @@
-Apache SkyWalking Nginx Agent For Kong
+Apache SkyWalking Kong Agent
 ==========
 
-This plugin base on Apache SkyWalking Nginx Agent for the Kong API gateway to 
integrate with the Apache SkyWalking distributed tracing system.
+<img src="http://skywalking.apache.org/assets/logo.svg"; alt="Sky Walking logo" 
height="90px" align="right" />
+
+[![Twitter 
Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
+
+![CI](https://github.com/apache/skywalking-kong/workflows/CI/badge.svg?branch=master)
+
+SkyWalking Kong agent built on [SkyWalking Nginx Lua 
agent](https://github.com/apache/skywalking-nginx-lua) to trace Kong API 
gateway to integrate with the [Apache 
SkyWalking](https://github.com/apache/skywalking) distributed tracing system.
+
 
 ## Usage
 
-1. Install the plugin on Kong:
+1. Install the plugin in Kong:
 
-To install kong-plugin-skywalking:
+Install kong-plugin-skywalking using `luarocks`:
 ```bash
 $ luarocks install kong-plugin-skywalking --local
 ```
@@ -48,4 +55,13 @@ $ curl -X POST --url http://localhost:8001/plugins/ \
    --data 'config.sample_ratio=100' \
    --data 'config.service_name=kong'
    --data 'config.service_instance_name=kong-with-skywalking'
-```
\ No newline at end of file
+```
+
+# Contact Us
+* Submit an [issue](https://github.com/apache/skywalking/issues) with `[KONG]` 
as the issue title prefix.
+* Mail list: **[email protected]**. Mail to 
`[email protected]`, follow the reply to subscribe the mail 
list.
+* Join `skywalking` channel at [Apache 
Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY).
 If the link is not working, find the latest one at [Apache INFRA 
WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
+* QQ Group: 392443393(2000/2000, not available), 901167865(available)
+
+# License
+Apache 2.0

Reply via email to