commit b316fffe106496b4fc12184b50fb9bbca59c725c
author Liam Miller-Cushon <cushon@google.com> Mon Mar 14 10:39:23 2022 -0700
committer google-java-format Team <google-java-format-dev+copybara@google.com> Mon Mar 14 10:40:18 2022 -0700
tree 4a05c173eb76d6e2f8e3a1379f6439b26111277d
parent e9410fc57a4a112bfb101a74c787e0ea66081229

Mention `--add-exports` in the docs for using g-j-f as a library

https://github.com/google/google-java-format/pull/760#pullrequestreview-902082926

PiperOrigin-RevId: 434504969

README.md

diff --git a/README.md b/README.md
index cdb82c9..02ef5c5 100644
--- a/README.md
+++ b/README.md
@@ -92,6 +92,18 @@
 legible java code. Just include the library in your maven/gradle/etc.
 configuration.
 
+`google-java-format` uses internal javac APIs for parsing Java source. The
+following JVM flags are required when running on JDK 16 and newer, due to
+[JEP 396: Strongly Encapsulate JDK Internals by Default](https://openjdk.java.net/jeps/396):
+
+```
+--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+```
+
 #### Maven
 
 ```xml