thischwa/CloudflareDNS-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Activity

Add Maven repository and usage instructions to README

Browse Source 
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:
Thilo Schwarz
2025-03-30 12:51:56 +02:00
parent 1a1794ff37
commit fd997bf6da
2 changed files with 26 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+25 -4
View File
@@ -12,8 +12,7 @@ Give it a try! [![GitHub release (latest by date including pre-releases)](https:
## Preface
This project offers minimalistic access to the Cloudflare API, focused on managing DNS settings like creating, updating,
and deleting DNS records. Supported types include A, CNAME, MX, TXT, and more.
This project provides a “java client” for minimalistic access to the Cloudflare API, which is mainly used for managing DNS settings such as creating, updating and deleting DNS records. Supported types are A, CNAME, MX, TXT and more.
If you encounter any bugs or find missing features, feel free to report them on
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
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!
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!
---
@@ -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
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).