readme

README.md

@@ -0,0 +1,22 @@
+# secret-santa
+```
+Santa or satan? 🎅🏿👹
+```
+This is a simple but very over-engineered secret santa manager web application written in go
+
+Why? Because I can. And because I wanted to learn how to write a web application in go.
+
+## Features
+ - [x] Web server is up and running
+ - [x] Basic API routes
+ - [x] Database migrations (only for sqlite)
+ - [ ] Configurable database connection
+ - [ ] Automatic database migrations (will be probably only supported for Docker deployments or with a guide)
+ - [ ] Tests
+ - [ ] Frontend using templates
+ - [ ] Authentication middleware
+
+## Used technologies
+ - [Go](https://go.dev/)
+ - [SQLc](https://sqlc.dev/)
+ - [SQL-Migrate](https://github.com/rubenv/sql-migrate)