Merge pull request #52 from Kuadrant/update-readme

add basic description
Kuadrant · Mar 8, 2024 · 4f0a5ee · 4f0a5ee
2 parents a8c9daa + d0e9f19
commit 4f0a5ee
Showing 1 changed file with 2 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
 # dns-operator
-// TODO(user): Add simple overview of use/purpose
-
-## Description
-// TODO(user): An in-depth paragraph about your project and overview of use
+The DNS Operator is a kubernetes based controller responsible for reconciling DNS Record and Managed Zone custom resources. It interfaces with cloud DNS providers such as AWS and Google to bring the DNS zone into the state declared in these CRDs. 
+One of the key use cases the DNS operator solves, is allowing complex DNS routing strategies such as Geo and Weighted to be expressed allowing you to leverage DNS as the first layer of traffic management. In order to make these strategies valuable, it also works across multiple clusters allowing you to use a shared domain name balance traffic based on your requirements.
 
 ## Getting Started
 You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.