Skip to content

Commit

Permalink
Doc/readme (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkinox authored Jan 11, 2024
1 parent 9a2c93d commit c7b4e5f
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 7 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Go version](https://img.shields.io/badge/Go-1.20-blue)](https://go.dev/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR)](https://codecov.io/gh/ankorstore/yokai)

> Simple, modular, and observable Go framework.
Expand Down
2 changes: 1 addition & 1 deletion config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/config-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/config-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/config)](https://goreportcard.com/report/github.com/ankorstore/yokai/config)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=config)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/config)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=config)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/config)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/config)](https://pkg.go.dev/github.com/ankorstore/yokai/config)

> Configuration module based on [Viper](https://github.com/spf13/viper).
Expand Down
2 changes: 1 addition & 1 deletion generate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/generate-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/generate-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/generate)](https://goreportcard.com/report/github.com/ankorstore/yokai/generate)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=generate)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/generate)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=generate)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/generate)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/generate)](https://pkg.go.dev/github.com/ankorstore/yokai/generate)

> Generation module based on [Google UUID](https://github.com/google/uuid).
Expand Down
2 changes: 1 addition & 1 deletion healthcheck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/healthcheck-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/healthcheck-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/healthcheck)](https://goreportcard.com/report/github.com/ankorstore/yokai/healthcheck)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=healthcheck)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/healthcheck)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=healthcheck)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/healthcheck)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/healthcheck)](https://pkg.go.dev/github.com/ankorstore/yokai/healthcheck)

> Health check module compatible with [K8s probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).
Expand Down
2 changes: 1 addition & 1 deletion httpclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/httpclient-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/httpclient-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/httpclient)](https://goreportcard.com/report/github.com/ankorstore/yokai/httpclient)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=httpclient)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/httpclient)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=httpclient)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/httpclient)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/httpclient)](https://pkg.go.dev/github.com/ankorstore/yokai/httpclient)

> Http client module based on [net/http](https://pkg.go.dev/net/http).
Expand Down
2 changes: 1 addition & 1 deletion httpserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/httpserver-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/httpserver-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/httpserver)](https://goreportcard.com/report/github.com/ankorstore/yokai/httpserver)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=httpserver)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/httpserver)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=httpserver)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/httpserver)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/httpserver)](https://pkg.go.dev/github.com/ankorstore/yokai/httpserver)


Expand Down
2 changes: 1 addition & 1 deletion log/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/log-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/log-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/log)](https://goreportcard.com/report/github.com/ankorstore/yokai/log)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=log)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/log)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=log)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/log)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/log)](https://pkg.go.dev/github.com/ankorstore/yokai/log)

> Logging module based on [Zerolog](https://github.com/rs/zerolog).
Expand Down
2 changes: 1 addition & 1 deletion trace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![ci](https://github.com/ankorstore/yokai/actions/workflows/trace-ci.yml/badge.svg)](https://github.com/ankorstore/yokai/actions/workflows/trace-ci.yml)
[![go report](https://goreportcard.com/badge/github.com/ankorstore/yokai/trace)](https://goreportcard.com/report/github.com/ankorstore/yokai/trace)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=5s0g5WyseS&flag=trace)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/trace)
[![codecov](https://codecov.io/gh/ankorstore/yokai/graph/badge.svg?token=ghUBlFsjhR&flag=trace)](https://app.codecov.io/gh/ankorstore/yokai/tree/main/trace)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ankorstore/yokai/trace)](https://pkg.go.dev/github.com/ankorstore/yokai/trace)

> Tracing module based on [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-go).
Expand Down

0 comments on commit c7b4e5f

Please sign in to comment.