Update README.md

README.md

@@ -13,9 +13,11 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki
 
 **EN** | <a href="README_CHT.md">中文</a>
 
-<!-- [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=yusing_godoxy&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy)
+**Currently working on [feat/godoxy-agent](https://github.com/yusing/godoxy/tree/feat/godoxy-agent).<br/>For contribution, please fork this instead of default branch.**
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=yusing_godoxy&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy)
+
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=yusing_godoxy&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy) -->
+<!-- [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) -->
 
 <img src="screenshots/webui.png" style="max-width: 650">
 
@@ -29,6 +31,7 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki
   - [Table of content](#table-of-content)
   - [Key Features](#key-features)
   - [Prerequisites](#prerequisites)
+  - [How does GoDoxy work](#how-does-godoxy-work)
   - [Setup](#setup)
   - [Screenshots](#screenshots)
     - [idlesleeper](#idlesleeper)
@@ -41,18 +44,16 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki
 
 - Easy to use
   - Effortless configuration
-  - Simple multi-node setup
+  - Simple multi-node setup with GoDoxy agents
   - Error messages is clear and detailed, easy troubleshooting
-- Auto SSL cert management (See [Supported DNS-01 Challenge Providers](https://github.com/yusing/godoxy/wiki/Supported-DNS%E2%80%9001-Providers))
+- Auto SSL with Let's Encrypt and DNS-01 (See [Supported DNS-01 Challenge Providers](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers))
-- Auto configuration for docker containers
 - Auto hot-reload on container state / config file changes
+- Create routes dynamically from running docker containers
 - **idlesleeper**: stop containers on idle, wake it up on traffic _(optional, see [screenshots](#idlesleeper))_
-- HTTP(s) reserve proxy
+- HTTP reserve proxy and TCP/UDP port forwarding
-- OpenID Connect support
+- OpenID Connect integration
-- [HTTP middleware support](https://github.com/yusing/godoxy/wiki/Middlewares)
+- [HTTP middleware](https://github.com/yusing/go-proxy/wiki/Middlewares) and [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages)
-- [Custom error pages support](https://github.com/yusing/godoxy/wiki/Middlewares#custom-error-pages)
+- **Web UI with App dashboard, config editor, _uptime monitor_, _system monitor_, _docker logs viewer_ (available on nightly builds)**
-- TCP and UDP port forwarding
-- **Web UI with App dashboard and config editor**
 - Supports linux/amd64, linux/arm64
 - Written in **[Go](https://go.dev)**
 
@@ -60,10 +61,20 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki
 
 ## Prerequisites
 
-Setup DNS Records point to machine which runs `GoDoxy`, e.g.
+Setup Wildcard DNS Record(s) for machine running `GoDoxy`, e.g.
 
-- A Record: `*.y.z` -> `10.0.10.1`
+- A Record: `*.domain.com` -> `10.0.10.1`
-- AAAA Record: `*.y.z` -> `::ffff:a00:a01`
+- AAAA Record (if you use IPv6): `*.domain.com` -> `::ffff:a00:a01`
+
+## How does GoDoxy work
+
+1. List all the containers
+2. Read container name, labels and port configurations for each of them
+3. Create a route if applicable (a route is like a "Virtual Host" in NPM)
+
+GoDoxy uses the label `proxy.aliases` as the subdomain(s), if unset it defaults to `container_name`.
+
+For example, with the label `proxy.aliases: qbt` you can access your app via `qbt.domain.com`.
 
 ## Setup
 
@@ -91,6 +102,8 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g.
 
 ### Metrics and Logs
 
+_In development, available on nightly builds._
+
 <div align="center">
   <table>
     <tr>