docs: add features to readme

This commit is contained in:
jabuxas 2024-10-16 23:48:28 -03:00
parent 7ed16a5397
commit 3cf851f232

View File

@ -1,8 +1,14 @@
# abyss
abyss is a basic (mostly) single user http server made for uploading files (logs, images) and then sharing them to the internet
abyss is a basic and mostly single user http server written in go made for uploading files (logs, images) and then sharing them to the internet
note: this is a project made for learning purposes, you should use other more mature projects if running in production. probably.
## features
- **file uploads**: supports uploading various file types, including images, videos, and documents.
- **flexible media display**: automatically renders uploaded files on a webpage based on their type (images, pdfs, videos, or plain text).
- **customizable interface**: allows for easy modification of color schemes and layout to suit specific design needs.
- **syntax highlighting for code**: syntax highlighting available by default for code files, with support for multiple programming languages. (can be tweaked/changed and even removed)
- **security considerations**: as it is single user, it's mostly secure but there are still some edges to sharpen
## table of contents