This is an automated email from the ASF dual-hosted git repository.

zkaoudi pushed a commit to branch zkaoudi-patch-3
in repository https://gitbox.apache.org/repos/asf/wayang.git

commit 6cf3cf2d6d485f7071c647ff7eb4d86ef9481de8
Author: Zoi Kaoudi <[email protected]>
AuthorDate: Wed Mar 11 15:07:56 2026 +0100

    Create README.md for Wayang JSON REST API
    
    Add initial README with how to start a Wayang REST server
---
 wayang-api/wayang-api-json/REAME.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/wayang-api/wayang-api-json/REAME.md 
b/wayang-api/wayang-api-json/REAME.md
new file mode 100644
index 000000000..ece8e7b4f
--- /dev/null
+++ b/wayang-api/wayang-api-json/REAME.md
@@ -0,0 +1,18 @@
+# Wayang JSON REST API
+
+## Getting Started
+
+### 1. Package the Project
+
+```bash
+./mvnw clean package -pl :wayang-assembly -Pdistribution
+```
+
+### 2. Starting the REST API as a Background Process
+
+```bash
+cd wayang-assembly/target/
+tar -xvf apache-wayang-assembly-1.1.1-dist.tar.gz
+cd wayang-1.1.1
+./bin/wayang-submit org.apache.wayang.api.json.Main
+```

Reply via email to