summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <[email protected]>2026-07-16 23:48:10 -0500
committerChristian Cleberg <[email protected]>2026-07-16 23:48:10 -0500
commitd8195992e519343d6d8ff7fb17aa98358800d913 (patch)
tree09ef08c1c06ac55c84299d5fd1251755fe0cac4f /README.md
parent1edf5bc83c0dcc07246908af341f37e2c871edd7 (diff)
downloaddomain-dig-4.4.1.tar.gz
domain-dig-4.4.1.tar.bz2
domain-dig-4.4.1.zip
DomainDig v4.4.1: Consolidate Audit Mode and remove the CLI targetv4.4.1
- Make DomainDig/DomainDig/Audit* the single active Audit Mode implementation (models, views, exporter) with an Audit tab and session/export UI - Include audit sessions in backup/restore lifecycle counts, summaries, and merge behavior via DomainDataPortabilityService - Remove the DomainDigCLI target, source file, scheme, and all project references; keep the shared inspection/report pipeline for the app - Align AppVersion.current to 4.4.1 and refresh README/architecture docs - Add RELEASE_ROADMAP.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md68
1 files changed, 42 insertions, 26 deletions
diff --git a/README.md b/README.md
index 0797eef..5d9b458 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,32 @@
-# domain-dig
+# DomainDig
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=zerolabsco_domain-dig&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=zerolabsco_domain-dig)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=zerolabsco_domain-dig&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=zerolabsco_domain-dig)
-Domain Dig is a minimal iOS to perform DNS lookups.
+DomainDig is a local-first iOS domain inspection toolkit for DNS, web, ownership, monitoring, reporting, and audit workflows. The app gathers a point-in-time domain snapshot, normalizes it into a canonical `DomainReport`, and keeps user data on device unless the user exports, shares, or syncs it.
-## Features
+## Current Release Target
-Data provided by a Domain Dig search:
+Immediate release target: `v4.4.1`.
-- Reachability
-- Redirect Chain
-- DNS Records
-- Email Security
-- SSL/TLS Certificate
-- HTTP Headers
- - "Grade" for header security
-- IP Location
-- Open Ports
- - Custom port checks
+This patch release focuses on release readiness: resolving duplicate Audit Mode implementations, aligning app/project version metadata, preserving audit persistence and backup/restore coverage, and refreshing docs for the current app surface.
-Extra features:
+## Features
-- Save favorite domains for quick reuse
-- Check historical log of searches and their results
-- Change DNS resolver to Cloudflare, Google, Quad9, or a custom resolver
+- Domain inspection for DNS records, email security, TLS certificates, HTTP headers, redirects, IP geolocation, reachability, open ports, RDAP, ownership, subdomain discovery, and availability.
+- Canonical `DomainReport` output used by the app UI and exports.
+- History snapshots with change summaries, risk scoring, notes, and saved domain context.
+- Dashboard, watchlist, monitoring, workflows, batch results, integrations, and data portability screens.
+- Audit Mode with sessions, checklist progress, reviewer notes, findings, evidence snapshots, audit timelines, and markdown/json/pdf export.
+- Backup and restore for tracked domains, history, audit sessions, workflows, monitoring settings/logs, app settings, and local feature metadata.
+- Local-first operation with no required backend.
+- Optional local API surface for automation-compatible report output.
-## Contributing
+## Data And Privacy
-Contributions are welcome. Keep changes scoped, include tests when behavior changes, and open a pull request with a clear summary of the user-facing impact.
+DomainDig stores local app data in on-device persistence. Backup exports can include tracked domains, lookup history, audit sessions, workflow definitions, monitoring configuration, monitoring logs, app settings, and cached feature metadata. Imports are processed on device.
+
+Network inspection requests are made only to perform the requested domain checks or configured resolver lookups. The app does not require a hosted DomainDig backend.
## Development
@@ -36,23 +34,41 @@ Contributions are welcome. Keep changes scoped, include tests when behavior chan
- Xcode with current iOS SDK support
- iOS Simulator or physical iOS device
+- Swift/Xcode support for filesystem-synchronized groups used by the project
### Getting Started
-1. Clone the repository:
+1. Clone the repository.
```sh
- git clone https://git.sr.ht/~ccleberg/DomainDig
+ git clone https://github.com/zerolabsco/domain-dig.git
```
-2. Open the project in Xcode.
-3. Build and run the app on a simulator or device.
+2. Open `DomainDig.xcodeproj` in Xcode.
+3. Select the `DomainDig` scheme.
+4. Build and run on a simulator or device.
+
+### Useful Checks
+
+```sh
+xcodebuild -project DomainDig.xcodeproj -scheme DomainDig -destination 'platform=iOS Simulator,name=iPhone 16' build
+```
+
+The app and local API share the canonical report pipeline through `DomainInspectionService`, `DomainReportBuilder`, and `DomainReportExporter`.
+
+## Release Planning
+
+See `RELEASE_ROADMAP.md` for the semver release plan from `v4.4.1` through the planned `v5.0.0` stabilization milestone.
+
+## Contributing
+
+Contributions are welcome. Keep changes scoped, include tests or build verification when behavior changes, and open a pull request with a clear summary of user-facing impact.
## Security
-If you discover a security issue, see SECURITY.md.
+If you discover a security issue, see `SECURITY.md`.
## License
-This project is licensed under the GPL 3.0 or later. See LICENSE.
+This project is licensed under GPL 3.0 or later. See `LICENSE`.
## Contact