diff options
Diffstat (limited to 'README.nfo')
| -rw-r--r-- | README.nfo | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/README.nfo b/README.nfo new file mode 100644 index 0000000..3b26ee7 --- /dev/null +++ b/README.nfo @@ -0,0 +1,74 @@ +┌──────────────────────────────────────────────────────────────┐ +│ D O M A I N D I G [ KRZ ] krz.sh │ +└──────────────────────────────────────────────────────────────┘ + +WHAT + local-first ios domain inspection toolkit. dns, web, ownership, + monitoring, reporting, audit. takes a point-in-time snapshot of a + domain, normalizes it into a DomainReport, and keeps data on device + unless you export, share, or sync it. + +DOES + - inspects dns records, email security, tls certs, http headers, + redirects, ip geolocation, reachability, open ports, rdap, + ownership, subdomains, availability + - DomainReport output used by the ui and exports + - history snapshots with change summaries, risk scoring, notes + - dashboard, watchlist, monitoring, workflows, batch results, + integrations, data portability + - audit mode: sessions, checklists, reviewer notes, findings, + evidence snapshots, timelines, markdown/json/pdf export + - backup and restore for tracked domains, history, audit sessions, + workflows, monitoring, settings, feature metadata + - optional local api for automation-compatible output + +PRIVACY + app data lives in on-device storage. network requests go out only + to run the checks you asked for or the resolver you configured. no + hosted backend required. + +BUILD + needs xcode with a current ios sdk and a simulator or device. + + git clone https://github.com/krazywarez/domain-dig.git + + open DomainDig.xcodeproj, pick the DomainDig scheme, build and run. + + build check: + + xcodebuild -project DomainDig.xcodeproj -scheme DomainDig \ + -destination 'platform=iOS Simulator,name=iPhone 16' build + +TESTS + deterministic core coverage lives in DomainDigTests: + + xcodebuild test -project DomainDig.xcodeproj -scheme DomainDig \ + -destination 'platform=iOS Simulator,name=iPhone 16' \ + -only-testing:DomainDigTests + + the scheme's test action also runs the DomainDigUITests + accessibility audit. + + ./Scripts/audit-a11y.sh # oldest supported + newest + ./Scripts/audit-a11y.sh floor # oldest only (~85s) + + findings are reported, not enforced. optional pre-push hook: + + git config core.hooksPath .githooks + +DOCS + local api: Docs/local-api.txt + data migration: Docs/data-migration.txt + accessibility: Docs/ACCESSIBILITY.txt + releases: RELEASE_ROADMAP.txt (v4.4.1 -> v5.0.0) + security: SECURITY.txt + +LICENSE + 0bsd. see LICENSE. + +CONTACT + +┌──────────────────────────────────────────────────────────────┐ +│ krz.sh │ +└──────────────────────────────────────────────────────────────┘ |
