Add Maven repository and usage instructions to README
Updated the README to include instructions for integrating the project into a Maven-based setup, like adding the repository and dependency configurations. These changes assist developers in easily utilizing the library.
This commit is contained in:
@@ -12,8 +12,7 @@ Give it a try! [.
|
the [GitHub Issues page](https://github.com/th-schwarz/CloudflareDNS-java/issues).
|
||||||
@@ -22,8 +21,7 @@ the [GitHub Issues page](https://github.com/th-schwarz/CloudflareDNS-java/issues
|
|||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
This guide comes without any warranty. Use at your own risk. The author is not responsible for potential data loss,
|
This guide comes without any warranty. Use at your own risk. The author is not responsible for potential data loss, hardware damage or keyboard mishaps!
|
||||||
hardware damage, or keyboard mishaps!
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -33,6 +31,29 @@ BETA
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Get It
|
||||||
|
|
||||||
|
The project has its own maven repository. To use it the repository must be added to the `pom.xml`:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>github-cloudflaredns</id>
|
||||||
|
<name>GitHub Maven Packages</name>
|
||||||
|
<url>https://maven.pkg.github.com/th-schwarz/CloudflareDNS-java</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
```
|
||||||
|
|
||||||
|
At next the dependency must be added:
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>codes.thischwa</groupId>
|
||||||
|
<artifactId>cloudflaredns</artifactId>
|
||||||
|
<version>0.1.0-beta.1</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
## Methods Overview
|
## Methods Overview
|
||||||
|
|
||||||
The following text focuses on the basic methods. For further information take a look at the [javadoc of the CfDnsClient](https://th-schwarz.github.io/CloudflareDNS-java/apidocs/codes/thischwa/cf/CfDnsClient.html).
|
The following text focuses on the basic methods. For further information take a look at the [javadoc of the CfDnsClient](https://th-schwarz.github.io/CloudflareDNS-java/apidocs/codes/thischwa/cf/CfDnsClient.html).
|
||||||
|
|||||||
@@ -51,6 +51,7 @@
|
|||||||
<connection>scm:git:git@github.com:th-schwarz/CloudflareDNS-java</connection>
|
<connection>scm:git:git@github.com:th-schwarz/CloudflareDNS-java</connection>
|
||||||
<tag>HEAD</tag>
|
<tag>HEAD</tag>
|
||||||
</scm>
|
</scm>
|
||||||
|
|
||||||
<distributionManagement>
|
<distributionManagement>
|
||||||
<repository>
|
<repository>
|
||||||
<id>github-cloudflaredns</id>
|
<id>github-cloudflaredns</id>
|
||||||
|
|||||||
Reference in New Issue
Block a user