Merge pull request #11 from permitio/asaf/per-5429-java-readme

Add javadoc link to readme MD
permitio · Jun 20, 2023 · 1a335ae · 1a335ae
2 parents ae3effd + 292cc96
commit 1a335ae
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -138,3 +138,8 @@ Most params to UserCreates are optional, and only the unique user key is needed.
 ```java
 CreateOrUpdateResult<UserRead> result = permit.api.users.sync(new UserCreate("[USER KEY]"));
 ```
+
+## Javadoc reference
+To view the javadoc reference, [click here](https://javadoc.io/doc/io.permit/permit-sdk-java/1.3.0/index.html).
+
+It's easiest to start with the root [Permit](https://javadoc.io/static/io.permit/permit-sdk-java/1.3.0/io/permit/sdk/Permit.html) class.