Skip to content

Commit 64ee277

Browse files
Apply core review changes to README (#40)
* Add deploy-oss * Add finalName and fix the java doc * Update README.md file * Update README.md Co-authored-by: Guilherme Dellagustin <[email protected]> * Update README.md --------- Co-authored-by: Guilherme Dellagustin <[email protected]>
1 parent 42e53bb commit 64ee277

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
> [!WARNING]
44
> The publishing process of this repository is still in progress.
55
6-
# cds-feature-auditlog-ng
6+
# CDS plugin for SAP Audit Log service
77

88
## About this project
99

10-
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.
10+
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.
1111

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

9595
## Requirements and Setup
9696

97-
*Insert a short description what is required to get your project running...*
97+
To get your project running, ensure you have the following prerequisites:
98+
99+
- Java 17 or higher installed
100+
- A user-provided service instance for SAP Audit Log service created in your Cloud Foundry space
101+
- The Maven dependency for `cds-feature-auditlog-ng` added to your project
98102

99103
## Support, Feedback, Contributing
100104

0 commit comments

Comments
 (0)