jabuxas/abyss
jabuxas/abyss
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

docs: add screenshots to readme

Browse Source
This commit is contained in:
jabuxas 2024-10-17 00:23:14 -03:00
parent 3cf851f232
commit a66f40fc38
1 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -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 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 <figure>
<img src="https://github.com/user-attachments/assets/eae42368-d8b5-4c42-ac8a-0e1486fcd0d4" alt="homepage"/>
- **file uploads**: supports uploading various file types, including images, videos, and documents. <figcaption>this is abyss' default home page<figcaption/>
- **flexible media display**: automatically renders uploaded files on a webpage based on their type (images, pdfs, videos, or plain text). </figure>
- **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 ## table of contents
- [features](#features)
- [running abyss](#running) - [running abyss](#running)
- [installing with docker](#docker) - [installing with docker](#docker)
- [installing manually](#manual) - [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) - [theming](#theming)
- [docs](#docs) - [docs](#docs)
- [todo list](#todo) - [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: ## running:
@ -138,3 +145,15 @@ end
- [x] custom file displaying!! - [x] custom file displaying!!
- [x] syntax highlighting - [x] syntax highlighting
- [ ] add rate limits - [ ] add rate limits
## pictures
<figure>
<img src="https://github.com/user-attachments/assets/32ce9b3a-8c0f-4bb5-bdcf-3a602e0c81e6"/>
<figcaption>this is abyss' default directory list<figcaption/>
</figure>
<figure>
<img src="https://github.com/user-attachments/assets/7072b227-9972-4c2a-a9f3-384d2efb4fe1"/>
<figcaption>this is abyss' default file presentation<figcaption/>
</figure>