From 651d47409893ed5d233fc7ee126c9bdae221b4b0 Mon Sep 17 00:00:00 2001
From: Yancey <1709185482@qq.com>
Date: Fri, 9 Feb 2024 18:14:16 +0800
Subject: [PATCH] Update README.md

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..693b6c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# OpenParticle
+
+A minecraft fabric mod to summon particle in minecraft.
+
+The particle files loaded by this mod are stored in binary format, which can greatly accelerate the export and import
+speed of particle files.
+
+The powerful particle combination can store a large number of particles with minimal file size and memory usage.
+
+Multithreading particle VBO filling can greatly improve your particle rendering speed.
+
+## Command
+
+load particle in file:
+
+```mcfunction
+par file load path_to_your_file
+```
+
+run particle:
+
+```mcfunction
+par file run
+```
+
+load particle in file and run it:
+
+```mcfunction
+par file loadAndRun path_to_your_file
+```
+
+## How to create a particle file
+
+You can find the api in this package: `yancey.openparticle.api.common`.
+
+clone it to your java project, or implement the same logic in whatever language you like.
+
+Have fun!!!
\ No newline at end of file