add README and SECURITY

1 files changed, 56 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9ed40f7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# domain-dig
+
+Domain Dig is a minimal iOS to perform DNS lookups.
+
+## Features
+
+Data provided by a Domain Dig search:
+
+- Reachability
+- Redirect Chain
+- DNS Records
+- Email Security
+- SSL/TLS Certificate
+- HTTP Headers
+  - "Grade" for header security
+- IP Location
+- Open Ports
+  - Custom port checks
+
+Extra 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
+
+## Contributing
+
+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.
+
+## Development
+
+### Requirements
+
+- Xcode with current iOS SDK support
+- iOS Simulator or physical iOS device
+
+### Getting Started
+
+1. Clone the repository:
+   ```sh
+   git clone https://git.sr.ht/~ccleberg/DomainDig
+   ```
+2. Open the project in Xcode.
+3. Build and run the app on a simulator or device.
+
+## Security
+
+If you discover a security issue, see SECURITY.md.
+
+## License
+
+This project is licensed under the GPL 3.0 or later. See LICENSE.
+
+## Contact
+
+Questions or feedback: [email protected]