Update README.md

Add usage example
dziegel · Feb 15, 2024 · b2f83a3 · b2f83a3
1 parent 44f4662
commit b2f83a3
Showing 1 changed file with 10 additions and 0 deletions.
diff --git 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