feat: add readme

This commit is contained in:
Lucas Barbieri 2024-08-19 13:01:23 -03:00
parent 356019944b
commit edcab64df5

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# abyss
abyss is a basic http server made for uploading 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
## running:
- edit consts in `main.go` to match your needs. (for example, on my server, change `$url` so that the response will be nicely formatted)
- to run it, either build with `go build -o abyss` or run it directly with:
```
go run ./main.go
```
## todo:
- add upload of logs funcionality (like 0x0.st)
- add docker easy setup