docs: packages

README.md

@@ -5,7 +5,8 @@
 
 some packages collected for easy and often used functions
 
-- `file`: Read and Save - JSON, TOML
 - `database`: Start by Config, Migrate
-- `worker`: cronjob
+- `file`: Read and Save - JSON, TOML
+- `mailer`: Send E-Mail and receive for testing
 - `web`: helpers for golang-gin framework e.g. websocket, metrics, status, auth
+- `worker`: cronjob

database/docs.go

@@ -0,0 +1,4 @@
+/*
+Package database implements common functionality for database with gorm.
+*/
+package database

mailer/docs.go

@@ -0,0 +1,4 @@
+/*
+Package mailer implements common functionality for sending emails and for testing
+*/
+package mailer

web/api/status/docs.go

@@ -0,0 +1,4 @@
+/*
+Package status implements for web the module to publish the status with version and other extras
+*/
+package status

web/auth/docs.go

@@ -0,0 +1,4 @@
+/*
+Package auth implements for web the module for authentification
+*/
+package auth

web/metrics/docs.go

@@ -0,0 +1,4 @@
+/*
+Package metrics implements for web the module to publish prometheus metrics
+*/
+package metrics

web/webtest/docs.go

@@ -0,0 +1,4 @@
+/*
+Package webtest implements an easy way to write test for web modules
+*/
+package webtest