tenkuma/zephyrus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added readme.md

Browse source
This commit is contained in:
天クマ 2024-11-17 01:57:47 +01:00
commit e9805e4526
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.MD Normal file
View file

@ -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.