Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 56 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,59 @@
# echo-guard

Echo middleware adapter for [guard-core-go](https://github.com/Guard-Core/guard-core-go). Translates `echo.Context` into the guardcore request surface, runs the engine, and translates verdicts to exact Echo responses (status, headers, body, then stop the chain). Works with any `echo.Echo` or `echo.Group` chain via `e.Use`.

Docs: <https://guard-core.github.io/echo-guard/>
<p align="center">
<a href="https://guard-core.github.io/guard-core/latest/">
<img src="https://guard-core.github.io/guard-core/latest/assets/guard_core_legend.svg" alt="Guard Core">
</a>
</p>

___

<p align="center">
<strong>Echo middleware adapter for [guard-core-go](https://github.com/Guard-Core/guard-core-go). Translates `echo.Context` into the guardcore request surface, runs the engine, and translates verdicts to exact Echo responses (status, headers, body, then stop the chain). Works with any `echo.Echo` or `echo.Group` chain via `e.Use`.</strong>
</p>

<p align="center">
<a href="https://github.com/Guard-Core/echo-guard/releases">
<img src="https://img.shields.io/github/v/tag/Guard-Core/echo-guard?label=release&color=0080ff" alt="Release tag">
</a>
<a href="https://guard-core.github.io/echo-guard/latest/">
<img src="https://img.shields.io/badge/docs-latest-0080ff.svg" alt="Docs">
</a>
<a href="https://github.com/Guard-Core/echo-guard/actions/workflows/release.yml">
<img src="https://github.com/Guard-Core/echo-guard/actions/workflows/release.yml/badge.svg" alt="Release">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
</a>
<a href="https://github.com/Guard-Core/echo-guard/actions/workflows/ci.yml">
<img src="https://github.com/Guard-Core/echo-guard/actions/workflows/ci.yml/badge.svg" alt="CI">
</a>
<a href="https://github.com/Guard-Core/echo-guard/actions/workflows/code-ql.yml">
<img src="https://github.com/Guard-Core/echo-guard/actions/workflows/code-ql.yml/badge.svg" alt="CodeQL">
</a>
</p>

<p align="center">
<a href="https://github.com/Guard-Core/echo-guard/actions/workflows/pages/pages-build-deployment">
<img src="https://github.com/Guard-Core/echo-guard/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages" alt="PagesBuildDeployment">
</a>
<a href="https://github.com/Guard-Core/echo-guard/actions/workflows/docs.yml">
<img src="https://github.com/Guard-Core/echo-guard/actions/workflows/docs.yml/badge.svg" alt="DocsUpdate">
</a>
<img src="https://img.shields.io/github/last-commit/Guard-Core/echo-guard?style=flat&amp;logo=git&amp;logoColor=white&amp;color=0080ff" alt="last-commit">
</p>

<p align="center">
<img src="https://img.shields.io/badge/Echo-365CF5.svg?style=flat" alt="Echo">
</p>

<p align="center">
<a href="https://guard-core.com">Website</a> &middot;
<a href="https://guard-core.github.io/echo-guard/latest/">Docs</a> &middot;
<a href="https://playground.guard-core.com">Playground</a> &middot;
<a href="https://app.guard-core.com">Dashboard</a> &middot;
<a href="https://discord.gg/ZW7ZJbjMkK">Discord</a>
</p>

---

## Install

Expand Down
Loading