chore: add initial README

.traefik.yml

@@ -4,9 +4,8 @@ iconPath: .assets/logo.png
 
 import: github.com/taskmedia/ddnswhitelist
 
-summary: 'A middleware that allows you to specify Dynamic DNS to IP whitelist'
+summary: 'A middleware that allows you to whitelist on a dynamic DNS'
 
 testData:
-  Headers:
-    X-Demo: test
-    X-URL: '{{URL}}'
+  ddnsHostList:
+  - my.router.ddns.tld

README.md

@@ -1,9 +1,52 @@
-# DDNSwhitelist
+# DDNSwhitelist - Traefik Plugin
 
 Dynamic DNS whitelist plugin for Traefik.
 
 ## About
 
-:warning: This traefik plugin is currently in development!
+The `DDNSwhitelist` plugin for Traefik allows you to whitelist dynamic DNS (DDNS) hosts. Requests from IP addresses that do not resolve to the specified DDNS hosts will be denied.
 
-Please do not use it yet!
+The existing plugins can be browsed into the [Plugin Catalog](https://plugins.traefik.io).
+
+## Installation
+
+To install the `DDNSwhitelist` plugin, add the following configuration to your Traefik static configuration:
+
+```yaml
+experimental:
+  plugins:
+    ddnswhitelist:
+      moduleName: "github.com/taskmedia/ddnswhitelist"
+      version: v1.0.0
+```
+
+## Configuration
+
+Add the `DDNSwhitelist` middleware to your Traefik dynamic configuration:
+
+```yaml
+# Dynamic configuration
+
+http:
+  routers:
+    my-router:
+      rule: host(`demo.localhost`)
+      service: service-foo
+      entryPoints:
+        - web
+      middlewares:
+        - ddnswhitelist-router
+
+  services:
+    service-foo:
+      loadBalancer:
+        servers:
+          - url: http://127.0.0.1:5000
+
+  middlewares:
+    ddnswhitelist-router:
+      plugin:
+        ddnswhitelist:
+          DdnsHostList:
+            - my.router.ddns.tld
+```