From 03bbe498bf09d47b6cc2e2d55655797a01fd280c Mon Sep 17 00:00:00 2001
From: BuckarooBanzay <BuckarooBanzay@users.noreply.github.com>
Date: Tue, 21 May 2024 21:31:50 +0200
Subject: [PATCH] chatcommand

---
 readme.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index db306b0..5654efd 100644
--- a/readme.md
+++ b/readme.md
@@ -5,6 +5,16 @@ Generate isometric images from ingame builds
 
 ![](./isogen.png)
 
+# Commands
+
+If the `worldedit` mod is present you can use the following command to render the current we-region to a png-file:
+
+```
+//isogen [filename]
+```
+
+**NOTE**: larger regions require more memory
+
 # Api
 
 ## `isogen.draw(pos1, pos2, rotation?, cube_len?)`
@@ -14,7 +24,7 @@ Renders an isometric image and returns the png data
 Example:
 ```lua
 local pos1 = vector.new(0,0,0)
-local pos2 = vector.new(16,16,16)
+local pos2 = vector.new(16,16,16) -- NOTE: larger regions require more memory
 local rotation = 0
 local cube_len = 24 -- multiple of 4 and greater than 4 pixels