From 2ca7d0c7c7c51fe36148ff8b2af88d2429d122c0 Mon Sep 17 00:00:00 2001
From: Thomas Richner <thomas.richner@oviva.com>
Date: Wed, 22 May 2024 14:45:28 +0200
Subject: [PATCH] ARC-1699: Better README

---
 example/README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 example/README.md

diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..4f12bf3
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,69 @@
+# Spicegen Example
+
+## Code
+See [ExampleTest](./src/test/java/com/oviva/spicegen/example/ExampleTest.java).
+
+
+## Maven Setup
+Example [pom.xml](./pom.xml)
+```xml
+<project>
+
+    <!-- ... -->
+
+    <!--    see https://docs.github.com/de/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registr&lt;!&ndash;&ndash;&gt;y-->
+    <repositories>
+        <repository>
+            <id>spicegen</id>
+            <name>GitHub Oviva Spicegen</name>
+            <url>https://maven.pkg.github.com/oviva-ag/spicegen</url>
+        </repository>
+    </repositories>
+    <pluginRepositories>
+        <pluginRepository>
+            <id>spicegen</id>
+            <name>GitHub Oviva Spicegen Plugin</name>
+            <url>https://maven.pkg.github.com/oviva-ag/spicegen</url>
+        </pluginRepository>
+    </pluginRepositories>
+
+    <!-- ... -->
+
+    <dependencies>
+        <dependency>
+            <groupId>com.oviva.spicegen</groupId>
+            <artifactId>api</artifactId>
+            <version>...</version>
+        </dependency>
+        <dependency>
+            <groupId>com.oviva.spicegen</groupId>
+            <artifactId>spicedb-binding</artifactId>
+            <version>...</version>
+        </dependency>
+    </dependencies>
+
+    <!-- ... -->
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.oviva.spicegen</groupId>
+                <artifactId>spicegen-maven-plugin</artifactId>
+                <version>${project.version}</version>
+                <executions>
+                    <execution>
+                        <configuration>
+                            <schemaPath>${project.basedir}/src/test/resources/files.zed</schemaPath>
+                            <packageName>${project.groupId}.permissions</packageName>
+                            <outputDirectory>${project.basedir}/target/generated-sources/src/main/java</outputDirectory>
+                        </configuration>
+                        <goals>
+                            <goal>spicegen</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
+```
\ No newline at end of file