Update README.md

Cafully · Feb 2, 2023 · 717a639 · 717a639
1 parent 08664a4
commit 717a639
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,26 @@
 # Cafully
 
+![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)
 
+## Usage
+
+Add JVM Options
+
+`-javaagent:/absolute/path/to/cafully-agent.jar`
+
+If you usage `JDK17+` also add:
+
+```
+--add-opens=java.base/jdk.internal.org.objectweb.asm=ALL-UNNAMED
+--add-opens=java.base/jdk.internal.org.objectweb.asm.tree=ALL-UNNAMED
+```
+
+## Plugin
+
+### Usage
+
+Drag the plugin file to the plugin folder
+
+### Custom
+
+[example-cafully-plugin](https://github.com/Cafully/example-cafully-plugin)