Merge pull request #1 from da0p/feature/daoph/Add-README

[DR] Feat: Update README.md
da0p · Aug 11, 2024 · eee82f3 · eee82f3
2 parents be12549 + d662ec5
commit eee82f3
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# DNS resolver
+
+[![Build Status](https://github.com/da0p/dns_resolver/actions/workflows/ci.yml/badge.svg)](https://github.com/dns_resolver/dns_resolver/actions)
+
+Resolving a host name following [RFC-1035](https://datatracker.ietf.org/doc/html/rfc1035)
+
+# Installation
+
+- Download or clone the project
+- In the project directory, run
+```rust
+cargo build
+```
+- In order to resolve a host name, run
+```rust
+cargo run -- HOST_NAME
+```
+- In order to run the test
+```rust
+cargo test
+```