Skip to content

Commit

Permalink
ARC-1699: Better README
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasrichner-oviva committed May 22, 2024
1 parent 571f5f0 commit 2ca7d0c
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -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>
```

0 comments on commit 2ca7d0c

Please sign in to comment.