From b2f83a39c13c797cb3c4d34f6f226b2717d34ce4 Mon Sep 17 00:00:00 2001
From: Dirk Ziegelmeier <dirk@ziegelmeier.net>
Date: Thu, 15 Feb 2024 07:58:27 +0100
Subject: [PATCH] Update README.md

Add usage example
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 95d9aea..880e308 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,16 @@ This is a C++ statemachine generator that generates statemachines based on <http
 
 The Eclipse Epsilon <https://eclipse.dev/epsilon> framework is used to implement the generator.
 
+## Usage
+
+The generator is a Java JAR file. To generate, call it as follows:
+
+    java -jar StatemachineGenerator-x.y.z.jar <uml> <out_path>
+
+example:
+
+    java -jar StatemachineGenerator-1.4.0.jar PathToMyDiagram.uml ./generated
+
 ## License
 
 Apache-2.0