Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

Java client for the [ControlResell](https://controlresell.com) public API (Java 11+).

## Install

From the 0.1.0 release, on Maven Central:

```xml
<dependency>
<groupId>com.controlresell</groupId>
<artifactId>java-sdk</artifactId>
<version>0.1.0</version>
</dependency>
```


```java
ControlResell client = new ControlResell("cr_live_..."); // or ControlResell.builder().build() with CONTROLRESELL_API_KEY
Me me = client.me().get();
Expand Down Expand Up @@ -43,4 +56,4 @@ Retries (rate limits, 502/503/504, network errors), `Idempotency-Key` on every `
mvn test
```

Maven coordinates, once published: `com.controlresell:java-sdk`. Not published yet. Licensed under the Apache License 2.0.
Licensed under the Apache License 2.0.
57 changes: 56 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,16 @@
</licenses>
<scm>
<url>https://github.com/controlresell/java-sdk</url>
<connection>scm:git:https://github.com/controlresell/java-sdk.git</connection>
<connection>scm:git:git://github.com/controlresell/java-sdk.git</connection>
<developerConnection>scm:git:ssh://git@github.com/controlresell/java-sdk.git</developerConnection>
</scm>
<developers>
<developer>
<id>controlresell</id>
<name>ControlResell</name>
<url>https://controlresell.com</url>
</developer>
</developers>

<properties>
<maven.compiler.release>11</maven.compiler.release>
Expand Down Expand Up @@ -77,4 +85,51 @@
</plugin>
</plugins>
</build>

<!-- Maven Central needs a Javadoc jar and signatures: mvn -B clean deploy -Prelease (gpg key, "central" server in settings.xml). -->
<profiles>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.12.0</version>
<configuration>
<doclint>none</doclint>
<quiet>true</quiet>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals><goal>jar</goal></goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.2.8</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals><goal>sign</goal></goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.central</groupId>
<artifactId>central-publishing-maven-plugin</artifactId>
<version>0.12.0</version>
<extensions>true</extensions>
<configuration>
<publishingServerId>central</publishingServerId>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
Loading