Add Readme

funnyboy-roks · Nov 13, 2022 · dfd6b30 · dfd6b30
1 parent 222f617
commit dfd6b30
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+![](https://maven.funnyboyroks.com/api/badge/latest/snapshots/com/funnyboyroks/DrawLib?color=40c14a&name=DrawLib&prefix=v)
+
+# DrawLib
+
+(Name Pending to Change)
+
+A simple library to draw some simple shapes using particles in Paper servers
+
+![Screenshot](./img/screenshot.png)
+
+## Usage
+
+See the [maven repo](https://maven.funnyboyroks.com/#/snapshots/com/funnyboyroks/DrawLib/1.0.0-SNAPSHOT) for the latest version and code snippets for your `pom.xml`.
+
+```java
+ShapeRenderer renderer = new ShapeRenderer();
+
+renderer.setColor(Color.RED);
+renderer.setReceivers(player);
+renderer.drawLine(point1, point2);
+```
+
+## Current Shapes
+
+- Point
+- Line
+- Cuboid
+- Sphere
diff --git a/img/screenshot.png b/img/screenshot.png