diff --git a/README.md b/README.md index 7c00d5e..fb2c6ce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # GoUtils -![Go Coverage](https://git.mstar.dev/mstar/goutils/raw/branch/main/coverage_badge.png) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://git.mstar.dev/mstar/goutils/src/branch/main/LICENSE) +![Go Coverage](https://git.mstar.dev/mstar/goutils/raw/branch/main/coverage_badge.png) +[![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://git.mstar.dev/mstar/goutils/src/branch/main/LICENSE) +[![Go Documentation](https://godocs.io/git.mstar.dev/mstar/goutils?status.svg)](https://godocs.io/git.mstar.dev/mstar/goutils) +[![GoDoc](https://pkg.go.dev/badge/git.mstar.dev/mstar/goutils)](https://pkg.go.dev/git.mstar.dev/mstar/goutils) A collection of useful functions and structs that I use for my projects. diff --git a/containers/generics.go b/containers/generics.go index 9465afd..993cf81 100644 --- a/containers/generics.go +++ b/containers/generics.go @@ -1,3 +1,4 @@ +// Package containers contains implementations of a generic queue and stack package containers type chainElem[T any] struct { diff --git a/embedFsWrapper/wrapper.go b/embedFsWrapper/wrapper.go index e266f91..be6428d 100644 --- a/embedFsWrapper/wrapper.go +++ b/embedFsWrapper/wrapper.go @@ -1,3 +1,5 @@ +// Package embedFsWrapper contains a wrapper around [io/fs.FS] for working +// around a limitation of the [embed] package package embedFsWrapper import ( diff --git a/http/chain.go b/http/chain.go index 30dfb71..23c9328 100644 --- a/http/chain.go +++ b/http/chain.go @@ -1,3 +1,5 @@ +// Package webutils contains various functions for easier interaction and common tasks +// when working with [net/http.Handler] based webservers package webutils import ( diff --git a/maputils/mapUtils.go b/maputils/mapUtils.go index a9db4d5..38bae9d 100644 --- a/maputils/mapUtils.go +++ b/maputils/mapUtils.go @@ -1,3 +1,4 @@ +// Package maputils contains various generic functions for applying an operation on an entire map package maputils import "git.mstar.dev/mstar/goutils/sliceutils" diff --git a/math/math.go b/math/math.go index 8f04ebc..d33fe2f 100644 --- a/math/math.go +++ b/math/math.go @@ -1,3 +1,4 @@ +// Package mathutils contains helper functions for performing common mathematical operations package mathutils type SignedNumber interface { diff --git a/other/other.go b/other/other.go index f63b0b0..c20ec0d 100644 --- a/other/other.go +++ b/other/other.go @@ -1,3 +1,4 @@ +// Package other contains various funtions that didn't fit into any of the other packages package other import "fmt" diff --git a/sliceutils/sliceUtils.go b/sliceutils/sliceUtils.go index 19a9a6f..26e45b9 100644 --- a/sliceutils/sliceUtils.go +++ b/sliceutils/sliceUtils.go @@ -1,3 +1,4 @@ +// Package sliceutils contains various generic functions for applying an operation across an entire slice package sliceutils // MapS applies a given function to every element of a slice.