Skip to content

Commit 717a639

Browse files
committed
Update README.md
1 parent 08664a4 commit 717a639

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
# Cafully
22

3+
![GitHub](https://img.shields.io/github/license/Cafully/cafully?style=flat-square) ![Maven Central](https://img.shields.io/maven-central/v/cn.enaium.cafully/cafully-agent?style=flat-square)
34

5+
## Usage
6+
7+
Add JVM Options
8+
9+
`-javaagent:/absolute/path/to/cafully-agent.jar`
10+
11+
If you usage `JDK17+` also add:
12+
13+
```
14+
--add-opens=java.base/jdk.internal.org.objectweb.asm=ALL-UNNAMED
15+
--add-opens=java.base/jdk.internal.org.objectweb.asm.tree=ALL-UNNAMED
16+
```
17+
18+
## Plugin
19+
20+
### Usage
21+
22+
Drag the plugin file to the plugin folder
23+
24+
### Custom
25+
26+
[example-cafully-plugin](https://github.com/Cafully/example-cafully-plugin)

0 commit comments

Comments
 (0)