Skip to content

Commit

Permalink
update readmes and ga actions
Browse files Browse the repository at this point in the history
  • Loading branch information
cardinalby committed Jun 25, 2024
1 parent d0df3b0 commit 34560e0
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/list.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
list:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: actions/setup-go@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
test:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: actions/setup-go@v4
with:
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/cardinalby/hureg.svg)](https://pkg.go.dev/github.com/cardinalby/hureg)
[![list](https://github.com/cardinalby/hureg/actions/workflows/list.yml/badge.svg)](https://github.com/cardinalby/hureg/actions/workflows/list.yml)
[![list](https://github.com/cardinalby/hureg/actions/workflows/list.yml/badge.svg)](https://github.com/cardinalby/hureg/actions/workflows/list.yml)

![hureg logo](./docs/hureg.png)

[HUMA](https://github.com/danielgtaylor/huma) is a great Go framework that enables you to
Expand Down
5 changes: 5 additions & 0 deletions pkg/huma/metadata/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Pre-defined Metadata keys

[![Go Reference](https://pkg.go.dev/badge/github.com/cardinalby/hureg/pkg/huma/metadata.svg)](https://pkg.go.dev/github.com/cardinalby/hureg/pkg/huma/metadata)

[Hureg docs →](./../../../docs/metadata.md)
5 changes: 5 additions & 0 deletions pkg/huma/oapi_handlers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## OpenAPI handlers

[![Go Reference](https://pkg.go.dev/badge/github.com/cardinalby/hureg/pkg/huma/oapi_handlers.svg)](https://pkg.go.dev/github.com/cardinalby/hureg/pkg/huma/oapi_handlers)

[Hureg docs →](./../../../docs/openapi_endpoints.md)
2 changes: 2 additions & 0 deletions pkg/huma/op_handler/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Operation Handlers package

[![Go Reference](https://pkg.go.dev/badge/github.com/cardinalby/hureg/pkg/huma/op_handler.svg)](https://pkg.go.dev/github.com/cardinalby/hureg/pkg/huma/op_handler)

### Introduction

This package provides a set of _Operation Handlers_ that plays well with `hureg` library.
Expand Down

0 comments on commit 34560e0

Please sign in to comment.