Skip to content

Apply core review changes to README #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 15, 2025
Merged

Apply core review changes to README #40

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6c40bb1
Add deploy-oss
mtsvetanov071 Jul 3, 2025
963dcd7
Merge branch 'main' of github.com:cap-java/cds-feature-auditlog-ng
mtsvetanov071 Jul 3, 2025
034b8a8
Add finalName and fix the java doc
mtsvetanov071 Jul 3, 2025
b6835e0
Merge branch 'main' of github.com:cap-java/cds-feature-auditlog-ng
mtsvetanov071 Jul 14, 2025
6711439
Update README.md file
mtsvetanov071 Jul 14, 2025
4a0c91f
Update README.md
mtsvetanov071 Jul 15, 2025
ed47e2b
Update README.md
mtsvetanov071 Jul 15, 2025
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
> [!WARNING]
> The publishing process of this repository is still in progress.
# cds-feature-auditlog-ng
# CDS plugin for SAP Audit Log service

## About this project

The Audit Log Service NG Java CAP plugin enables Java CAP applications to emit audit log events in a standardized way. It is fully compatible with the [Audit Log Event Catalog](https://github.tools.sap/wg-observability/telemetry-semantic-conventions/tree/audit-log-events?tab=readme-ov-file#event-catalog), ensuring standardized event semantics and compatibility.
The CDS plugin for SAP Audit Log service enables Java CAP applications to emit audit log events in a standardized way. It is fully compatible with the Audit Log Event Catalog, ensuring standardized event semantics and compatibility.

You can emit the following types of audit log events:
- Personal Data Access Event
Expand Down Expand Up @@ -94,7 +94,11 @@ This file simulates the Cloud Foundry environment variables required for your ap

## Requirements and Setup

*Insert a short description what is required to get your project running...*
To get your project running, ensure you have the following prerequisites:

- Java 17 or higher installed
- A user-provided service instance for SAP Audit Log service created in your Cloud Foundry space
- The Maven dependency for `cds-feature-auditlog-ng` added to your project

## Support, Feedback, Contributing

Expand Down