aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c6bd78
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+[![progress-banner](https://backend.codecrafters.io/progress/http-server/a3b8daaf-8f1f-42b7-b527-f0af4a45c537)](https://app.codecrafters.io/users/zwlucas?r=2qF)
+
+This is a starting point for Go solutions to the
+["Build Your Own HTTP server" Challenge](https://app.codecrafters.io/courses/http-server/overview).
+
+[HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) is the
+protocol that powers the web. In this challenge, you'll build a HTTP/1.1 server
+that is capable of serving multiple clients.
+
+Along the way you'll learn about TCP servers,
+[HTTP request syntax](https://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html),
+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 HTTP server implementation is in `app/server.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/server.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.