Skip to content

Commit 5d8a309

Browse files
authored
Add usage instructions to readme (#30)
* add usage instructions to readme Signed-off-by: Sam Spycher <[email protected]> --------- Signed-off-by: Sam Spycher <[email protected]>
1 parent b125eb6 commit 5d8a309

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,43 @@ The repository contains the following packages:
1616

1717
# How to use this library
1818

19-
TODO
19+
To use the Parsec JCA provider in your Maven project, you need to:
20+
21+
1. **Configure GitHub Packages Repository:**
22+
Add the following repository configuration to your project's `pom.xml`. This allows Maven to find and download Parsec Java Client artifacts from GitHub Packages.
23+
24+
```xml
25+
<project>
26+
...
27+
<repositories>
28+
<repository>
29+
<id>github-parallaxsecond</id>
30+
<name>GitHub Parallax Second Apache Maven Packages</name>
31+
<url>https://maven.pkg.github.com/parallaxsecond/parsec-client-java</url>
32+
</repository>
33+
</repositories>
34+
...
35+
</project>
36+
```
37+
38+
2. **Add the Dependency:**
39+
Add the `parsec-jca-java` artifact as a dependency in your `pom.xml`:
40+
41+
```xml
42+
<dependencies>
43+
...
44+
<dependency>
45+
<groupId>org.parallaxsecond</groupId>
46+
<artifactId>parsec-jca-java</artifactId>
47+
<version>0.1.0</version> <!-- Replace with the desired version -->
48+
</dependency>
49+
...
50+
</dependencies>
51+
```
52+
53+
This will also bring in the necessary transitive dependencies: `parsec-client-java`, `parsec-interface-java`, and `parsec-protobuf-java`. For other JVM build systems, please take the necessary coordinates (`groupId`, `artifactId`, `version`) and adapt to your dependency management syntax. You can find the latest available version on the [project's GitHub Packages page](https://github.com/parallaxsecond/parsec-client-java/packages).
54+
55+
If you don't want to use the JCA, you can employ this library in a more parsec-idiomatic way by depending directly on `parsec-client-java`. _Note:_ this is not a recommendation either way.
2056

2157
# How to develop the Parsec Java Client
2258

0 commit comments

Comments
 (0)