From e9805e4526a65a335ae3b18ee179476f27b0ae80 Mon Sep 17 00:00:00 2001 From: adrianvictor Date: Sun, 17 Nov 2024 01:57:47 +0100 Subject: [PATCH] Added readme.md --- README.MD | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.MD diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..78d60a4 --- /dev/null +++ b/README.MD @@ -0,0 +1,11 @@ +# Zephyrus +Zephyrus is a *VERY* simple HTTP(S) webserver written in TypeScript. Take a look on our [wiki](https://git.disroot.org/adrianvictor/zephyrus/wiki) for setup instructions. + +## Main features +- HTTPS support. +- Directory listing with custom CSS (with a trick you should also be able to use custom JS). +- Default page when accessing root. +- Automatic MIME type detection. + +## Disclaimer +This is maintained by a computing student (and as the year I'm writing this, I'm in my first year), I have no knowledge to provide something secure, I will work to improve my skills, but there's no guarantee I'll won't let something obvious pass. DO NOT RUN ZEPHYRUS AS ROOT. \ No newline at end of file