starred/godoxy-yusing
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-01-11 22:30:47 +01:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

docs: enhance package README documentation

Browse Source
This commit is contained in:
yusing
2026-01-09 10:27:55 +08:00
parent 45c821fa98
commit 4275cdae38
4 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
goutils

Submodule goutils updated: dacd33b6b8...78fda75d1e

9
internal/autocert/README.md
View File

@@ -144,6 +144,11 @@ flowchart TD
T --> V[Update SNI Matcher] T --> V[Update SNI Matcher]
V --> G V --> G
style E fill:#22553F,color:#fff
style I fill:#8B8000,color:#fff
style N fill:#22553F,color:#fff
style U fill:#84261A,color:#fff
``` ```
### SNI Matching Flow ### SNI Matching Flow
@@ -163,6 +168,10 @@ flowchart LR
F -->|Yes| D F -->|Yes| D
F -->|No| G[Return default cert] F -->|No| G[Return default cert]
end end
style C fill:#27632A,color:#fff
style E fill:#18597A,color:#fff
style F fill:#836C03,color:#fff
``` ```
### Suffix Tree Structure ### Suffix Tree Structure

2
internal/entrypoint/README.md
View File

@@ -9,7 +9,7 @@ The entrypoint package implements the primary HTTP handler that receives all inc
### Key Features ### Key Features
- Domain-based route lookup with subdomain support - Domain-based route lookup with subdomain support
- Short link (`go/<short-code>` domain) handling - Short link (`go/<alias>` domain) handling
- Middleware chain application - Middleware chain application
- Access logging for all requests - Access logging for all requests
- Configurable not-found handling - Configurable not-found handling

2
internal/homepage/widgets/README.md
View File

@@ -109,7 +109,7 @@ var HTTPClient = &http.Client{
### Available Providers ### Available Providers
- **qbittorrent** - qBittorrent torrent client integration (WIP) - **qbittorrent** - qBittorrent torrent client integration _(WIP)_
## Usage Example ## Usage Example