diff --git a/README.md b/README.md index 2c2667c..4f0f8f9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ -# stereo.cat backend +# stereo.cat backend! -written in Go, uses Gin. +## Introduction +This is the backend that is supposed to glue together our frontend with our database & S3. + +## Technologies +* Golang (1.24.2+) (worst mistake of our entire lives) +* Gin (web framework) +* Gorm (database ORM) +* MinIO S3 SDK (for storing images) -## database shit +## Contributing +1. Make sure you test your PR before submitting. +2. Make sure that it works everywhere. +3. Format your code, make it look nice :D +4. Make sure to add an explanation. -Instead of using Discord oAuth as a database, we instead use it as a login source, only using it to source a username/id, avatar data and a secure login/registration flow. -We store these attributes alongside stereo.cat specific attributes in our own database. There is a trade-off however: this means that avatar & username data is not updated in real-time, only when the oauth flow is executed. +To generate a patch file, first commit your changes and then do: +```bash +git format-patch -1 HEAD +``` +Patches can be sent to hex@iwakura.rip.