Skip to content

Commit

Permalink
Add a simple description about the helper container
Browse files Browse the repository at this point in the history
Signed-off-by: Juan Antonio Osorio <juan.osoriorobles@eu.equinix.com>
  • Loading branch information
JAORMX committed Sep 6, 2022
1 parent 10ca132 commit cfded4a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

A small and flexible library to help you create audit events.

It also includes a helper container image for you to be able to forward audit events.

## Context

While audit logging may seem like a very simple thing to add to an application, doing it right is
Expand Down Expand Up @@ -48,4 +50,4 @@ both have prometheus metric support baked in.
A simple utility to read audit logs and reliably output them.
e.g. in a sidecar container.

[Read more.](docs/audittail.md)
[Read more.](docs/audittail.md)

0 comments on commit cfded4a

Please sign in to comment.