add ci workflow (closes #2)

README.md

@@ -1,3 +1,13 @@
 # keycloak-mailcow
 
-Keycloak User Storage Provider for mailcow
+Keycloak User Storage SPI for mailcow
+
+Connects to a mailcow MariaDB database and uses the `username` and `password` columns of the `mailbox` table for authentication.
+
+Currently, only BCrypt-hashed passwords are supported.
+
+## References
+
+- https://www.baeldung.com/java-keycloak-custom-user-providers
+- https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/inc/functions.inc.php
+- https://www.keycloak.org/docs/latest/server_development/index.html#_user-storage-spi