diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 22dedb5..5198f13 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -34,14 +34,24 @@ jobs:
- name: Verify with Maven
if: github.event_name == 'pull_request'
- run: mvn -B clean verify
+ run: mvn -B clean verify
- - name: Build with Maven
- run: mvn -B compile --file pom.xml
+ - name: Verify javadoc
+ if: github.event_name == 'pull_request'
+ run: mvn -B -Prelease javadoc:test-javadoc
+
+ - name: Compile
+ run: mvn -B -Prelease compile
+
+ - name: Javadoc
+ run: mvn -B -Prelease javadoc:jar
+
+ - name: Source
+ run: mvn -B -Prelease source:jar
- name: Publish to Apache Maven Central
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
- run: mvn -X -Pbuild-extras,release deploy
+ run: mvn -B -Prelease deploy
env:
OSSRH_USERNAME: ${{ secrets.MAVEN_USERNAME }}
OSSRH_PASSWORD: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
diff --git a/README.md b/README.md
index 63cd0bb..045673f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,61 @@
-# projectmanager-sdk-java
-ProjectManager.com SDK for Java
+[![Maven Central](https://img.shields.io/maven-central/v/com.projectmanager/projectmanagersdk?style=plastic)](https://central.sonatype.com/artifact/com.projectmanager/projectmanagersdk)
+
+# ProjectManager.com SDK for API v4
+
+This software development kit contains all API definitions for the [ProjectManager.com](https://www.projectmanager.com) REST API v4.
+
+# Why use the SDK?
+
+The ProjectManager API v4 is available as a REST definition in OpenAPI format. You can read the documentation online at [developer.projectmanager.com](https://developer.projectmanager.com/).
+
+This SDK provides a few capabilities that developers may find more useful than hand-writing REST API code:
+* Documentation is available in your editor via autocomplete and hover docblocks
+* Patch notes are available detailing changes
+* Automated updates whenever new API endpoints are added
+
+# Using this SDK
+
+Here's how to add this SDK to create a project.
+
+First, you must add a reference in your `pom.xml` file. Check [the SonaType central page](https://central.sonatype.com/artifact/com.projectmanager/projectmanagersdk/overview) for the latest version number:
+
+```xml
+
+ com.projectmanager
+ projectmanagersdk
+ 97.0.2178
+
+```
+
+Next, run `mvn install`.
+
+To create an API client for ProjectManager within Java, you must specify:
+* Your API key, and
+* Your environment URL.
+
+For the ProjectManager production environment, the environment URL is `https://api.projectmanager.com`.
+
+To [obtain a ProjectManager.com API key](https://developer.projectmanager.com/reference/api-keys):
+* Log on to ProjectManager.com
+* Click your name in the bottom left hand corner
+* Select Account, then API
+* Follow the instructions on the page to create a new API key
+
+```java
+import com.projectmanager.ProjectManagerClient;
+
+public class JavaExample
+{
+ public static ProjectManagerClient GetProjectManagerClient(String apiKey, String env)
+ {
+ return ProjectManagerClient
+ .withEnvironment(env)
+ .withBearerToken(apiKey)
+ .WithAppName("MyApplicationName");
+ }
+}
+```
+
+
+
+
diff --git a/pom.xml b/pom.xml
index 3496687..27f3064 100644
--- a/pom.xml
+++ b/pom.xml
@@ -10,7 +10,7 @@
ProjectManagerSDK
Software development kit for the ProjectManager.com API. for Java
-
+ https://developer.projectmanager.com/
@@ -61,40 +61,44 @@
-
-
- ossrh
- https://oss.sonatype.org/content/repositories/snapshots
-
-
-
-
-
-
- org.sonatype.plugins
- nexus-staging-maven-plugin
- 1.6.8
- true
-
- ossrh
- https://s01.oss.sonatype.org/
- true
-
-
-
-
release
+
+ org.sonatype.central
+ central-publishing-maven-plugin
+ 0.1.2
+ true
+
+ central
+ true
+
+
org.apache.maven.plugins
maven-source-plugin
- 3.2.1
+ 3.3.0
attach-sources
+
+ jar-no-fork
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-javadoc-plugin
+ 3.6.0
+
+
+ attach-javadocs
+
+ jar
+
@@ -122,35 +126,5 @@
-
- build-extras
-
- true
-
-
-
-
- org.apache.maven.plugins
- maven-source-plugin
- 2.4
-
-
- attach-sources
-
-
-
-
- org.apache.maven.plugins
- maven-javadoc-plugin
- 2.10.3
-
-
- attach-javadocs
-
-
-
-
-
-
\ No newline at end of file