From 06a98a89956a9c035acbf9f0dfb1ae18e51b972f Mon Sep 17 00:00:00 2001 From: "Marcus W." Date: Tue, 29 Jul 2025 21:02:17 +0300 Subject: [PATCH] Organize docs and examples --- README.md | 10 +++++----- dkim-reference.md => docs/dkim-reference.md | 0 dmarc-CNAME-guide.md => docs/dmarc-CNAME-guide.md | 0 dmarc-reference.md => docs/dmarc-reference.md | 0 .../dns-bulk-change-template-filled.md | 0 spf-reference.md => docs/spf-reference.md | 0 domains.txt => examples/domains.txt | 0 .../parked-lock-record-sample.csv | 0 8 files changed, 5 insertions(+), 5 deletions(-) rename dkim-reference.md => docs/dkim-reference.md (100%) rename dmarc-CNAME-guide.md => docs/dmarc-CNAME-guide.md (100%) rename dmarc-reference.md => docs/dmarc-reference.md (100%) rename dns-bulk-change-template-filled.md => docs/dns-bulk-change-template-filled.md (100%) rename spf-reference.md => docs/spf-reference.md (100%) rename domains.txt => examples/domains.txt (100%) rename parked-lock-record-sample.csv => examples/parked-lock-record-sample.csv (100%) diff --git a/README.md b/README.md index a656c47..d6dcbd8 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Please install the following packages: ## Usage -Prepare a text file with one domain per line, for example `domains.txt`: +Prepare a text file with one domain per line, for example `examples/domains.txt`: ```text contoso.com @@ -47,13 +47,13 @@ rzy.domain.com Run the analyzer and specify the output CSV file: ```bash -python domain_analyzer.py domains.txt report.csv +python domain_analyzer.py examples/domains.txt report.csv ``` You can optionally set the number of parallel workers: ```bash -python domain_analyzer.py domains.txt report.csv 20 +python domain_analyzer.py examples/domains.txt report.csv 20 ``` The generated CSV includes the following columns: @@ -88,13 +88,13 @@ locking down parked or non-mailing domains. Provide a text file of domains and an output CSV path: ```bash -python scripts/parked_domain_csv.py domains.txt parked_domains.csv +python scripts/parked_domain_csv.py examples/domains.txt parked_domains.csv ``` Pass `--dmarc-cname` to override the default DMARC CNAME target: ```bash -python scripts/parked_domain_csv.py domains.txt parked_domains.csv --dmarc-cname reject.dmarc.contoso.com. +python scripts/parked_domain_csv.py examples/domains.txt parked_domains.csv --dmarc-cname reject.dmarc.contoso.com. ``` Each domain receives the following DNS entries: diff --git a/dkim-reference.md b/docs/dkim-reference.md similarity index 100% rename from dkim-reference.md rename to docs/dkim-reference.md diff --git a/dmarc-CNAME-guide.md b/docs/dmarc-CNAME-guide.md similarity index 100% rename from dmarc-CNAME-guide.md rename to docs/dmarc-CNAME-guide.md diff --git a/dmarc-reference.md b/docs/dmarc-reference.md similarity index 100% rename from dmarc-reference.md rename to docs/dmarc-reference.md diff --git a/dns-bulk-change-template-filled.md b/docs/dns-bulk-change-template-filled.md similarity index 100% rename from dns-bulk-change-template-filled.md rename to docs/dns-bulk-change-template-filled.md diff --git a/spf-reference.md b/docs/spf-reference.md similarity index 100% rename from spf-reference.md rename to docs/spf-reference.md diff --git a/domains.txt b/examples/domains.txt similarity index 100% rename from domains.txt rename to examples/domains.txt diff --git a/parked-lock-record-sample.csv b/examples/parked-lock-record-sample.csv similarity index 100% rename from parked-lock-record-sample.csv rename to examples/parked-lock-record-sample.csv