Skip to content

Commit 00b44cc

Browse files
authored
chore: add a section about uber-JARs to README
1 parent 39776bf commit 00b44cc

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Official Weaviate Java Client.
66

77
## Usage
88

9-
To start using Weaviate Java Client add this dependency to `pom.xml`:
9+
To start using Weaviate Java Client add the dependency to `pom.xml`:
1010

1111
```xml
1212

@@ -17,11 +17,17 @@ To start using Weaviate Java Client add this dependency to `pom.xml`:
1717
</dependency>
1818
```
1919

20-
### For applications on Java 9 or above
20+
### Uber JAR🫙
21+
22+
If you're building a uber-JAR with something like `maven-assembly-plugin`, use a shaded version with classifier `all`.
23+
This ensures that all dynamically-loaded dependecies of `io.grpc` are resolved correctly.
24+
25+
26+
### Gson and reflective access to internal JDK classes
2127

2228
The client uses Google's [`gson`](https://github.com/google/gson) for JSON de-/serialization which does reflection on internal `java.lang` classes. This is _not allowed by default_ in Java 9 and above.
2329

24-
To work around this, it's necessary to add this JVM commandline argument:
30+
To work around this, it's necessary to add this JVM command line argument:
2531

2632
```
2733
--add-opens=java.base/java.lang=ALL-UNNAMED

0 commit comments

Comments
 (0)