diff --git a/README.md b/README.md index 263d23b..e507e7a 100644 --- a/README.md +++ b/README.md @@ -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 + + + github-cloudflaredns + GitHub Maven Packages + https://maven.pkg.github.com/th-schwarz/CloudflareDNS-java + + +``` + +At next the dependency must be added: +```xml + + codes.thischwa + cloudflaredns + 0.1.0-beta.1 + +``` + ## 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). diff --git a/pom.xml b/pom.xml index 12ec6ce..796b9ca 100644 --- a/pom.xml +++ b/pom.xml @@ -51,6 +51,7 @@ scm:git:git@github.com:th-schwarz/CloudflareDNS-java HEAD + github-cloudflaredns