now using libmagic and its optional

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2438cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+### Web Server
+
+This is a simple http web server written in C with minimal dependencies.
+It uses the unix socket api and optionally libmagic for file information.
+
+### Build
+
+I don't like Makefile, so I wrote a shell script that compiles the program.
+Use `./build.sh help` to learn more about the build options and `./build.sh run` just to run the program
+
+### Limitation
+
+I have implemented only the GET request method, which just send the requested
+file from the `files` directory. There also isn't a hash table for the headers
+because I am lazy and it will make the project more unnessairly complex.