aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0ee1ebc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+[![progress-banner](https://backend.codecrafters.io/progress/dns-server/56e64eb6-693a-4a38-9144-8f7900295185)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
+
+This is a starting point for Go solutions to the
+["Build Your Own DNS server" Challenge](https://app.codecrafters.io/courses/dns-server/overview).
+
+In this challenge, you'll build a DNS server that's capable of parsing and
+creating DNS packets, responding to DNS queries, handling various record types
+and doing recursive resolve. Along the way we'll learn about the DNS protocol,
+DNS packet format, root servers, authoritative servers, forwarding servers,
+various record types (A, AAAA, CNAME, etc) and more.
+
+**Note**: If you're viewing this repo on GitHub, head over to
+[codecrafters.io](https://codecrafters.io) to try the challenge.
+
+# Passing the first stage
+
+The entry point for your `your_server.sh` implementation is in `app/main.go`.
+Study and uncomment the relevant code, and push your changes to pass the first
+stage:
+
+```sh
+git add .
+git commit -m "pass 1st stage" # any msg
+git push origin master
+```
+
+Time to move on to the next stage!
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+1. Ensure you have `go (1.19)` installed locally
+1. Run `./your_server.sh` to run your program, which is implemented in
+ `app/main.go`.
+1. Commit your changes and run `git push origin master` to submit your solution
+ to CodeCrafters. Test output will be streamed to your terminal.