From 28ee941bf354967e98a3147bd9b6840026b1c491 Mon Sep 17 00:00:00 2001
From: eeliu <27064129+eeliu@users.noreply.github.com>
Date: Wed, 7 Aug 2024 13:44:34 +0800
Subject: [PATCH] update readme
---
README.md | 9 +++--
Readme-CN.md | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++
Readme-KR.md | 0
3 files changed, 118 insertions(+), 3 deletions(-)
create mode 100644 Readme-CN.md
create mode 100644 Readme-KR.md
diff --git a/README.md b/README.md
index a1ab5553d..4e0e29424 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)
+
[](https://github.com/pinpoint-apm/pinpoint-c-agent/actions/workflows/main.yml) [](https://gitter.im/naver/pinpoint-c-agent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://codecov.io/gh/pinpoint-apm/pinpoint-c-agent) [](LICENSE) \
@@ -18,6 +20,7 @@
1. Use `C/Cpp` common API
2. `C`ross-platform: windows/*nux/macOS
+3. `C`llector-agent: a bridge to pinpoint-collector
Pinpoint C Agent helps your monitor your PHP/PYTHON applications into [pinpoint-apm](https://github.com/pinpoint-apm/pinpoint).\
Our advantage:
@@ -77,9 +80,9 @@ Our advantage:
show more
- QQ Group1: 897594820 | QQ Group2: 812507584 | QQ Group3: 882020485| DING Group : 21981598
- :----------------: |:----------------: | :-----------: | :-----------:
-  | | | 
+ | QQ Group1: 897594820 | QQ Group2: 812507584 | QQ Group3: 882020485 | DING Group : 21981598 |
+ | :------------------------------------: | :-------------------------------------: | :-------------------------------------: | :------------------------------------------------: |
+ |  |  |  |  |
## Contributing
diff --git a/Readme-CN.md b/Readme-CN.md
new file mode 100644
index 000000000..dd5d40d56
--- /dev/null
+++ b/Readme-CN.md
@@ -0,0 +1,112 @@
+[English](Readme.md) | [中文](Readme-CN.md) | [한국어](Readme-KR.md)
+
+
+
+[](https://github.com/pinpoint-apm/pinpoint-c-agent/actions/workflows/main.yml) [](https://gitter.im/naver/pinpoint-c-agent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://codecov.io/gh/pinpoint-apm/pinpoint-c-agent) [](LICENSE) \
+`pinpoint_php_ext:` [](https://pecl.php.net/package/pinpoint_php)\
+`pinpoint-php-aop:` 
+ [](https://packagist.org/packages/pinpoint-apm/pinpoint-php-aop)\
+`pinpointpy:` 
+ [](https://pypi.org/project/pinpointpy/)
+
+
+
+**Visit [our official website](http://pinpoint-apm.github.io/pinpoint/) for more information and [the Latest updates on Pinpoint](https://pinpoint-apm.github.io/pinpoint/news.html)**
+
+
+# Pinpoint `C` Agent
+
+> 为啥取名为 `C`
+
+1. 使用了 `C/Cpp` common 库的借口
+2. `C`ross-platform: 支持 windows/*nux/macOS 平台
+3. `C`llector-agent: 添加了一个桥接模块支持pinpoint-collector
+
+Pinpoint-c-agent 帮助您接入 [pinpoint-apm](https://github.com/pinpoint-apm/pinpoint) 监控平台.\
+我们的特点:
+1. 一直在维护和不停迭代. (Since Jul 31,2018)
+2. 支持自动切入代码，对您的项目更友好。
+ - python: 使用了 [PEP 318 Decorator](https://peps.python.org/pep-0318/)
+ - php: 使用 PHP内核提供的`CG(*_table)` 和AST 解析工具 ([nikic/PHP-Parser](https://github.com/nikic/PHP-Parser))
+3. 支持多种平台: windows/*nux/macOS. 方便你在开发的时候就接入项目，提前发现问题。
+
+## Python Agent
+
+> py 3.8+
+
+`pip install pinpointPy`
+
+[更详细的接入文档](DOC/PY/Readme.md)
+
+## PHP Agent
+
+> php 7.1+
+
+1. 安装 pinpoint_php 扩展 (pinpoint_php.so/pinpoint_php.dll)
+
+` pecl install pinpoint_php `
+
+2. 导入切面插件
+
+`composer require pinpoint-apm/pinpoint-php-aop`
+
+[更详细的接入文档](DOC/PHP/Readme.md)
+
+## C/CPP built in API
+
+[更详细的接入文档](DOC/C-CPP/Readme.md)
+
+
+## 提供的测试项目
+
+`cd testapps && docker compose build --build-arg PHP_VERSION=7.4 && docker compose up`
+
+[测试项目说明](/testapps/readme.md)
+
+### 博客
+
+- [Intro pinpoint php aop](https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/Intro-pinpoint-php-aop)
+- [pinpoint php aop 内部原理](https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/pinpoint-php-aop-%E5%86%85%E9%83%A8%E5%8E%9F%E7%90%86)
+- [pinpoint php aop 내부 원리](https://github.com/pinpoint-apm/pinpoint-php-aop/wiki/pinpoint-php-aop-%EB%82%B4%EB%B6%80-%EC%9B%90%EB%A6%AC)
+
+
+## Contact Us
+
+* Submit an [issue](https://github.com/pinpoint-apm/pinpoint-c-agent/issues) 👍👍
+* [Email Us](mailto:dl_cd_pinpoint@navercorp.com) 👍👍
+* [Gitter char room](https://gitter.im/naver/pinpoint-c-agent)
+* QQ us (QQ Group: 882020485)
+
+ show more
+
+
+ | QQ Group1: 897594820 | QQ Group2: 812507584 | QQ Group3: 882020485 | DING Group : 21981598 |
+ | :------------------------------------: | :-------------------------------------: | :-------------------------------------: | :------------------------------------------------: |
+ |  |  |  |  |
+
+
+## Contributing
+
+Thanks all [](https://github.com/pinpoint-apm/pinpoint-c-agent/graphs/contributors)
+
+We are looking forward to your contributions via pull requests.
+
+## License
+This project is licensed under the Apache License, Version 2.0.
+See [LICENSE](LICENSE) for full license text.
+
+```
+Copyright 2024 NAVER Corp.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
diff --git a/Readme-KR.md b/Readme-KR.md
new file mode 100644
index 000000000..e69de29bb