diff --git a/README.md b/README.md index e53e8b9..54219d1 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ ## About +The audit module, if enabled, allows other modules to write audit logs. It provides the `AuditLog` and `AuditStream` +hooks. Those are used by Icinga Web’s `AuditHook::logActivity()` to write audit logs. + +The screenshot shows how the audit logs look like in Icinga Web. + +![Screenshot - Audit Logs](doc/res/screenshot-audit-logs.png) + ## License Icinga Web 2 and this Icinga Web 2 module are licensed under the terms of the GNU General Public License Version 2, diff --git a/doc/res/screenshot-audit-logs.png b/doc/res/screenshot-audit-logs.png new file mode 100644 index 0000000..947c712 Binary files /dev/null and b/doc/res/screenshot-audit-logs.png differ