From d4c3b70d6290c52f903e674e9957b979abd4ce07 Mon Sep 17 00:00:00 2001
From: lamp
Date: Sun, 5 Mar 2023 21:37:45 +0000
Subject: init

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54071bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# tiny-serve
+A small, fast, fully asynchronous, and concurrent HTTP/1.1 server for static content stored on the filesystem, written in Rust using `async_std` and `futures`. 
+
+It uses a custom hand-written parser based on the relevant RFCs that sweeps over the message with a single byte of lookahead. The parser supports a reasonable subset of HTTP/1.1, but lacks some unnecessary grammar and such that are only used for optional, unimplemented HTTP/1.1 verbs.
+
+It accepts one command line argument, the port number to bind to:
+
+```
+tiny-serve 8080
+```
+
+which defaults to port 8000 if not specified or invalid.
\ No newline at end of file
-- 
cgit v1.2.3