Skip to content

Commit 3f21647

Browse files
authored
Document alternate artifacts (#1750)
1 parent b99de86 commit 3f21647

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Add this dependency to your project's POM:
3333
<dependency>
3434
<groupId>com.datadoghq</groupId>
3535
<artifactId>datadog-api-client</artifactId>
36-
<version>2.0.0</version>
36+
<version>2.10.0</version>
3737
<scope>compile</scope>
3838
</dependency>
3939
```
@@ -205,6 +205,25 @@ public class ProxyExample {
205205
}
206206
```
207207

208+
### Using alternative artifacts
209+
210+
Outside of the regular JAR file we also release 2 artifacts that can be useful for development, namely:
211+
- `jar-with-dependencies`, which contains all the dependencies of the client in a single JAR
212+
- `shaded-jar`, which includes and renames the core dependencies of the client, allowing you to use different versions of those
213+
libraries in your project.
214+
215+
To use them in Maven, just add the `classifier` keyword in the dependency definition. For example:
216+
217+
```xml
218+
<dependency>
219+
<groupId>com.datadoghq</groupId>
220+
<artifactId>datadog-api-client</artifactId>
221+
<version>2.10.0</version>
222+
<classifier>shaded-jar</classifier>
223+
<scope>compile</scope>
224+
</dependency>
225+
```
226+
208227
## Documentation for API Endpoints and Models
209228

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

0 commit comments

Comments
 (0)