From 400564a2026548a69a83b2afa65428b2686a0450 Mon Sep 17 00:00:00 2001
From: 0xgingi <0xgingi@0xgingi.com>
Date: Tue, 12 Nov 2024 13:34:49 -0500
Subject: [PATCH] 	new file:   README.md

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..22bc0e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# DNSpeedTest
+
+A fast, lightweight DNS resolver benchmarking tool written in Rust that measures the performance of popular DNS providers.
+
+## Features
+
+- Tests multiple popular DNS providers including Google, Cloudflare, Quad9, OpenDNS, and more
+- Measures average response time, minimum and maximum latency
+- Calculates success rate for DNS queries
+- Tests against commonly accessed domains
+- Provides detailed performance metrics in an easy-to-read format
+- Initial connection latency testing for each provider
+
+## Build from source
+
+1. Make sure you have Rust installed on your system
+2. Clone this repository
+```
+
+        git clone https://github.com/0xgingi/dnspeedtest
+        cd dnspeedtest
+```
+3. Build and run:
+```
+        cargo build --release
+        cargo run
+```
+## Configuration
+
+The tool comes pre-configured with several popular DNS providers and test domains. You can modify these in the source code:
+
+- `DNS_PROVIDERS`: List of DNS providers to test
+- `TEST_DOMAINS`: List of domains to query during testing
+- `TEST_ROUNDS`: Number of test iterations (default: 3)
\ No newline at end of file