From 6cf3cf2d6d485f7071c647ff7eb4d86ef9481de8 Mon Sep 17 00:00:00 2001 From: Zoi Kaoudi Date: Wed, 11 Mar 2026 15:07:56 +0100 Subject: [PATCH 1/3] 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(+) create mode 100644 wayang-api/wayang-api-json/REAME.md 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 +``` From 892e34db0ccf6d36958becde610f02ed961811ed Mon Sep 17 00:00:00 2001 From: Zoi Kaoudi Date: Wed, 11 Mar 2026 15:10:47 +0100 Subject: [PATCH 2/3] Update section title for starting the REST API Removed 'as a Background Process' from section title. --- wayang-api/wayang-api-json/REAME.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wayang-api/wayang-api-json/REAME.md b/wayang-api/wayang-api-json/REAME.md index ece8e7b4f..b4e8c5f70 100644 --- a/wayang-api/wayang-api-json/REAME.md +++ b/wayang-api/wayang-api-json/REAME.md @@ -8,7 +8,7 @@ ./mvnw clean package -pl :wayang-assembly -Pdistribution ``` -### 2. Starting the REST API as a Background Process +### 2. Starting the REST API ```bash cd wayang-assembly/target/ From 2eff380b264206382a8001d4c8cdf5eaadd20a78 Mon Sep 17 00:00:00 2001 From: Zoi Kaoudi Date: Wed, 11 Mar 2026 21:20:00 +0100 Subject: [PATCH 3/3] Update README with license Added license information description to README. --- wayang-api/wayang-api-json/REAME.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/wayang-api/wayang-api-json/REAME.md b/wayang-api/wayang-api-json/REAME.md index b4e8c5f70..903706a8d 100644 --- a/wayang-api/wayang-api-json/REAME.md +++ b/wayang-api/wayang-api-json/REAME.md @@ -1,3 +1,22 @@ + + # Wayang JSON REST API ## Getting Started