Skip to content

Commit e09b117

Browse files
committed
docs: Add badge and qrcode to README
1 parent a9ebd5e commit e09b117

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
1-
# Welcome to the CompoundVM!
1+
<div align="center">
2+
3+
# Compound Virtual Machine
4+
5+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bytedance/CompoundVM/.github/workflows/main.yml?branch=jdk17u-target8) [![License](https://img.shields.io/github/license/bytedance/CompoundVM)](https://github.com/bytedance/CompoundVM/blob/main/LICENSE) [![GitHub downloads](https://img.shields.io/github/downloads/bytedance/CompoundVM/total)](https://github.com/bytedance/CompoundVM/releases)
26

37
[中文版](README_cn.md)
48

9+
</div>
10+
11+
## Introduction
12+
513
For many legacy Java applications (e.g. using Java 8), upgrading the application to
614
higher version of JDK often requires costly and time-consuming project migration.
715

@@ -62,3 +70,9 @@ Notice the VM version, JVM 17 has been enabled in a JDK 8!
6270
## Contributing to CVM
6371

6472
See [CONTRIBUTING.md](CONTRIBUTING.md)
73+
74+
## Contact Us
75+
76+
Scan QR code to join discussion group
77+
78+
![qr](cvm/conf/wechat-group.png)

README_cn.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
# CompoundVM项目介绍
1+
<div align="center">
2+
3+
# Compound Virtual Machine
4+
5+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bytedance/CompoundVM/.github/workflows/main.yml?branch=jdk17u-target8) [![License](https://img.shields.io/github/license/bytedance/CompoundVM)](https://github.com/bytedance/CompoundVM/blob/main/LICENSE) [![GitHub downloads](https://img.shields.io/github/downloads/bytedance/CompoundVM/total)](https://github.com/bytedance/CompoundVM/releases)
6+
7+
</div>
8+
9+
## 项目简介
10+
211
很多存量的Java业务仍然在使用老旧的 Java 版本(如 Java 8),对于这些存量业务,升级 JDK 往往需要付出较大成本。
312
CompoundVM (CVM) 项目旨在解决这个痛点,通过将高版本 JVM 与低版本 JDK 组合,帮助业务用最小成本获得 Java 生态最新的性能收益。
413

@@ -16,7 +25,7 @@ CVM的主要特性如下:
1625

1726
## 性能数据
1827

19-
CVM已经在多种应用场景上进行功能和性能测试,包括JMH, SPECjbb2015, Flink nexmark等。与jdk8u372相比,
28+
CVM已经在多种应用场景上进行功能和性能测试,包括JMH, SPECjbb2015, Flink nexmark等。与jdk8u372相比
2029
一些性能数据如下:
2130

2231
| 应用场景 | 性能提升 |
@@ -51,3 +60,9 @@ OpenJDK 64-Bit Server VM (CompoundVM 8.0.0) (build 17.0.8+0, mixed mode)
5160
## 参与贡献
5261

5362
参见[CONTRIBUTING.md](CONTRIBUTING.md)
63+
64+
## 联系我们
65+
66+
扫码加入交流群
67+
68+
![qr](cvm/conf/wechat-group.png)

cvm/conf/wechat-group.png

18.2 KB
Loading

0 commit comments

Comments
 (0)