From f48ff281ea4a71a16c8ccbd219248d45f6f124da Mon Sep 17 00:00:00 2001
From: Anton Novojilov <andy@essentialkaos.com>
Date: Sun, 9 Jun 2024 00:02:08 +0300
Subject: [PATCH] Improve README

---
 .github/images/usage.svg | 71 ++++++++++++++++++++++++++++++++++++++++
 README.md                | 23 +------------
 2 files changed, 72 insertions(+), 22 deletions(-)
 create mode 100644 .github/images/usage.svg

diff --git a/.github/images/usage.svg b/.github/images/usage.svg
new file mode 100644
index 0000000..4f02096
--- /dev/null
+++ b/.github/images/usage.svg
@@ -0,0 +1,71 @@
+<!-- Generated by EK|SVAROG 0.0.2 -->
+<svg width="830" height="468" viewBox="0 0 830 468" fill="none" xmlns="http://www.w3.org/2000/svg">
+
+  <title>subdy Usage</title>
+
+  <defs>
+    <linearGradient id="fog" x1="0" x2="1" y1="0" y2="0">
+      <stop offset="0%" class="bg" stop-opacity="0" />
+      <stop offset="98%" class="bg" stop-opacity="1" />
+    </linearGradient>
+  </defs>
+
+  <style>
+    text { font-family: ui-monospace, 'JetBrains Mono', 'Fira Code', 'Iosevka', SFMono-Regular, 'SF Mono', Menlo, Consolas, 'Liberation Mono', monospace; font-size: 14px; font-display: swap; white-space: pre; }
+    tspan { white-space: pre; }
+
+    .bold { font-weight: bold; }
+    .italic { font-style: italic; }
+    .underline { text-decoration-line: underline; }
+    .dim { opacity: 0.75; }
+    .terminal { font-weight: bold; }
+
+    text { fill: #F5F5F5; }
+    .terminal { fill: #DDD; }
+    .bg { fill: #222; stop-color: #222; }
+    .window { fill: #2A2A2A; }
+    tspan.r { fill: #D22424; }
+    tspan.g { fill: #6DCB21; }
+    tspan.y { fill: #DAC425; }
+    tspan.b { fill: #5C9AD8; }
+    tspan.m { fill: #B6419E; }
+    tspan.c { fill: #38AFC5; }
+    tspan.LG { fill: #AAA; }
+    tspan.DG { fill: #696969; }
+    tspan.R { fill: #EF5A56; }
+    tspan.G { fill: #49E471; }
+    tspan.Y { fill: #E3E342; }
+    tspan.B { fill: #7AAAE4; }
+    tspan.M { fill: #B853D9; }
+    tspan.C { fill: #5FD5DE; }
+    tspan.W { fill: #BEBEBE; }
+    ::-moz-selection { color: #CCC; fill: #CCC; background: #444; }
+    ::selection { color: #CCC; fill: #CCC; background: #444; }
+
+  </style>
+
+  <rect width="830" height="468" x="0" y="0" rx="8" ry="8" class="bg" />
+  <path class="window" d="M8 0h814a8 8 0 0 1 8 8v22H0V8a8 8 0 0 1 8-8Z" shape="rect 0 0 830 30 8 8 0 0 1@c79e7e5e"/>
+
+  <circle r="6" cx="14" cy="15" fill="#FC615D" />
+  <circle r="6" cx="30" cy="15" fill="#FDBE41" />
+  <circle r="6" cx="46" cy="15" fill="#34C84A" />
+
+  <text x="50%" y="20" text-anchor="middle"><tspan class="terminal">Terminal</tspan></text>
+  <text x="12" y="56"><tspan class="bold">Usage:</tspan> <tspan class="bold c">subdy</tspan> <tspan class="g">{options}</tspan> domain</text>
+  <text x="12" y="96"><tspan class="bold">Options</tspan></text>
+  <text x="12" y="136">  <tspan class="g">--ip, -I</tspan> <tspan class="DG">...............</tspan> Resolve subdomains IP</text>
+  <text x="12" y="156">  <tspan class="g">--dns, -D</tspan> <tspan class="LG">name-or-url</tspan> <tspan class="DG">..</tspan> DoH provider <tspan class="DG">(cloudflare|google|url)</tspan></text>
+  <text x="12" y="176">  <tspan class="g">--no-color, -nc</tspan> <tspan class="DG">........</tspan> Disable colors in output</text>
+  <text x="12" y="196">  <tspan class="g">--help, -h</tspan> <tspan class="DG">.............</tspan> Show this help message</text>
+  <text x="12" y="216">  <tspan class="g">--version, -v</tspan> <tspan class="DG">..........</tspan> Show version</text>
+  <text x="12" y="256"><tspan class="bold">Examples</tspan></text>
+  <text x="12" y="296">  subdy go.dev</text>
+  <text x="12" y="316">  <tspan class="italic DG">Find all subdomains of go.dev</tspan></text>
+  <text x="12" y="356">  subdy -I go.dev</text>
+  <text x="12" y="376">  <tspan class="italic DG">Find all subdomains of go.dev and resolve their IPs</tspan></text>
+  <text x="12" y="416">  subdy -I -D google go.dev</text>
+  <text x="12" y="436">  <tspan class="italic DG">Find all subdomains of go.dev and resolve their IPs using Google DNS</tspan></text>
+
+  <rect x="800" y="30" width="30.3" height="418" fill="url(#fog)"/>
+</svg>
diff --git a/README.md b/README.md
index 950d57b..64d3c65 100644
--- a/README.md
+++ b/README.md
@@ -78,28 +78,7 @@ subdy --generate-man | sudo gzip > /usr/share/man/man1/subdy.1.gz
 
 ### Usage
 
-```
-Usage: subdy {options} domain
-
-Options
-
-  --ip, -I                 Resolve subdomains IP
-  --dns, -D name-or-url    DoH provider (cloudflare|google|url)
-  --no-color, -nc          Disable colors in output
-  --help, -h               Show this help message
-  --version, -v            Show version
-
-Examples
-
-  subdy go.dev
-  Find all subdomains of go.dev
-
-  subdy -I go.dev
-  Find all subdomains of go.dev and resolve their IPs
-
-  subdy -I -D google go.dev
-  Find all subdomains of go.dev and resolve their IPs using Google DNS
-```
+<img src=".github/images/usage.svg" />
 
 ### CI Status