Skip to content

Commit

Permalink
Document alternate artifacts (#1750)
Browse files Browse the repository at this point in the history
  • Loading branch information
therve authored Apr 18, 2023
1 parent b99de86 commit 3f21647
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.datadoghq</groupId>
<artifactId>datadog-api-client</artifactId>
<version>2.0.0</version>
<version>2.10.0</version>
<scope>compile</scope>
</dependency>
```
Expand Down Expand Up @@ -205,6 +205,25 @@ public class ProxyExample {
}
```

### Using alternative artifacts

Outside of the regular JAR file we also release 2 artifacts that can be useful for development, namely:
- `jar-with-dependencies`, which contains all the dependencies of the client in a single JAR
- `shaded-jar`, which includes and renames the core dependencies of the client, allowing you to use different versions of those
libraries in your project.

To use them in Maven, just add the `classifier` keyword in the dependency definition. For example:

```xml
<dependency>
<groupId>com.datadoghq</groupId>
<artifactId>datadog-api-client</artifactId>
<version>2.10.0</version>
<classifier>shaded-jar</classifier>
<scope>compile</scope>
</dependency>
```

## Documentation for API Endpoints and Models

Javadoc is available on [javadoc.io](https://www.javadoc.io/doc/com.datadoghq/datadog-api-client/latest/).
Expand Down

0 comments on commit 3f21647

Please sign in to comment.