From a66f40fc385ff7febfbadaa4fa803e0c38c3fad8 Mon Sep 17 00:00:00 2001 From: jabuxas Date: Thu, 17 Oct 2024 00:23:14 -0300 Subject: [PATCH] docs: add screenshots to readme --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3aa7bbe..78de575 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,14 @@ 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 -## 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 +
+ homepage +
this is abyss' default home page
+
## table of contents +- [features](#features) - [running abyss](#running) - [installing with docker](#docker) - [installing manually](#manual) @@ -19,6 +17,15 @@ abyss is a basic and mostly single user http server written in go made for uploa - [theming](#theming) - [docs](#docs) - [todo list](#todo) +- [more pictures](#pictures) + +## 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). +- **easily 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 ## running: @@ -138,3 +145,15 @@ end - [x] custom file displaying!! - [x] syntax highlighting - [ ] add rate limits + +## pictures + +
+ +
this is abyss' default directory list
+
+ +
+ +
this is abyss' default file presentation
+