docs: update readme according to template (#34)

betinacosta · web-flow · commit dbe1b7e91193 · 2026-03-12T10:30:17.000-03:00
diff --git a/README.md b/README.md
@@ -1,46 +1,14 @@
+![Build status](https://github.com/SAP/cloud-sdk-python/workflows/Build/badge.svg) [![REUSE status](https://api.reuse.software/badge/github.com/SAP/cloud-sdk-python)](https://api.reuse.software/info/github.com/SAP/cloud-sdk-python)
+
 # SAP Cloud SDK for Python
 
+## About this project
+
 This SDK provides consistent interfaces for interacting with foundational services such as object storage, destination management, audit logging, telemetry, and secure credential handling.
 
 The Python SDK offers a clean, type-safe API following Python best practices while maintaining compatibility with the SAP Application Foundation ecosystem.
 
----
-
-## Available Modules
-
-- [AuditLog User Guide](src/sap_cloud_sdk/core/auditlog/user-guide.md) - Compliance audit logging for SAP Audit Log Service
-- [Destination User Guide](src/sap_cloud_sdk/destination/user-guide.md) - SAP BTP Destination Service integration with proxy support
-- [ObjectStore User Guide](src/sap_cloud_sdk/objectstore/user-guide.md) - S3-compatible object storage
-- [Secret Resolver User Guide](src/sap_cloud_sdk/core/secret_resolver/user-guide.md) - Secure credential management from mounted volumes and environment variables
-- [Telemetry User Guide](src/sap_cloud_sdk/core/telemetry/user-guide.md) - OpenTelemetry tracing and GenAI auto-instrumentation
-
----
-
-## Installation
-
-TODO: To be defined
-
----
-
-## Quick Start
-
-```python
-from sap_cloud_sdk.objectstore import create_client
-
-# Create an ObjectStore client (auto-detects local vs cloud)
-client = create_client("my-instance")
-
-# Upload a file
-client.put_object_from_bytes(
-    name="example.txt",
-    data=b"Hello, World!", 
-    content_type="text/plain"
-)
-```
-
----
-
-## Key Features
+### Key Features
 
 - 🤖 **AI Core Integration**
 - 📋 **Audit Log Service**
@@ -49,123 +17,64 @@ client.put_object_from_bytes(
 - 🔐 **Secret Resolver**
 - 📊 **Telemetry & Observability**
 
----
-
-## Requirements
+## Requirements and Setup
 
 - **Python**: 3.11 or higher
 
-## Environment Configuration
+### Installation
 
-The SDK automatically resolves configuration from multiple sources with the following priority:
+```python
+# uv
+uv add sap-cloud-sdk
 
-1. **Kubernetes-mounted secrets**: `/etc/secrets/<module>/<instance>/<field>`
-2. **Environment variables**: `<MODULE>_<INSTANCE>_<FIELD>`
-   - For instance names, hyphens (`"-"`) are replaced with underscores (`"_"`) for compatibility with system environment variables.
+# Poetry
+poetry add sap-cloud-sdk
 
-### ObjectStore Configuration Example
+# Pip
+pip install sap-cloud-sdk
+````
 
-```bash
-# Environment variables for ObjectStore with instance name "credentials"
-export OBJECTSTORE_CREDENTIALS_ACCESS_KEY_ID="your-access-key"
-export OBJECTSTORE_CREDENTIALS_SECRET_ACCESS_KEY="your-secret-key"  
-export OBJECTSTORE_CREDENTIALS_BUCKET="your-bucket-name"
-export OBJECTSTORE_CREDENTIALS_HOST="s3.amazonaws.com"
-```
+### Environment Configuration
 
-### Kubernetes Mounted Secrets Example
+The SDK automatically resolves configuration from multiple sources with the following priority:
 
-```
-/etc/secrets/objectstore/credentials/
-├── access_key_id
-├── secret_access_key
-├── bucket
-└── host
-```
+1. **Kubernetes-mounted secrets**: `/etc/secrets/appfnd/<module>/<instance>/<field>`
+2. **Environment variables**: `CLOUD_SDK_CFG_<MODULE>_<INSTANCE>_<FIELD>`
+   - For instance names, hyphens (`"-"`) are replaced with underscores (`"_"`) for compatibility with system environment variables.
+   - You can see examples in our [env_integration_tests.example](.env_integration_tests.example)
 
 ### Telemetry Configuration
 
 For production environments (SAP BTP Managed Runtime), no configuration is needed as `OTEL_EXPORTER_OTLP_ENDPOINT` is automatically injected.
 
 For local development:
+
 ```bash
 export OTEL_EXPORTER_OTLP_ENDPOINT="https://otel-collector.example.com"
 ```
 
----
+### Usage Guides
 
-## Usage Examples
+Each module has comprehensive usage guides:
 
-### Audit Logging
+- [AuditLog](src/sap_cloud_sdk/core/auditlog/user-guide.md)
+- [Destination](src/sap_cloud_sdk/destination/user-guide.md)
+- [ObjectStore](src/sap_cloud_sdk/objectstore/user-guide.md)
+- [Secret Resolver](src/sap_cloud_sdk/core/secret_resolver/user-guide.md)
+- [Telemetry](src/sap_cloud_sdk/core/telemetry/user-guide.md)
 
-```python
-from sap_cloud_sdk.core.auditlog import (create_client, SecurityEvent)
-
-# Create audit log client
-client = create_client()
-
-# Security event - authentication attempt
-security_event = SecurityEvent(
-    data="User login attempt",
-    user="john.doe",
-    tenant=Tenant.PROVIDER,
-    identity_provider="SAP ID",
-    ip="192.168.1.100",
-    attributes=[
-        SecurityEventAttribute("login_method", "password"),
-        SecurityEventAttribute("session_id", "abc123")
-    ]
-)
-client.log(security_event)
-```
+## Support, Feedback, Contributing
 
-### Secret Resolver
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/cloud-sdk-python/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
 
-Securely load configuration and credentials from Kubernetes mounted volumes or environment variables:
+## Security / Disclosure
 
-```python
-from dataclasses import dataclass, field
-from sap_cloud_sdk.core.secret_resolver import read_from_mount_and_fallback_to_env_var
-
-# Load configuration
-config = DatabaseConfig()
-read_from_mount_and_fallback_to_env_var(
-    base_volume_mount="/etc/secrets",
-    base_var_name="MYAPP",
-    module="database", 
-    instance="primary",
-    target=config
-)
-```
+If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/cloud-sdk-python/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
 
-### Telemetry with GenAI Auto-instrumentation
+## Code of Conduct
 
-Comprehensive telemetry and observability for AI applications with automatic instrumentation:
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
 
-```python
-from sap_cloud_sdk.core.telemetry import (
-    auto_instrument, context_overlay, GenAIOperation,
-    chat_span, execute_tool_span, invoke_agent_span,
-    record_metrics, set_tenant_id, add_span_attribute
-)
-
-# Enable auto-instrumentation before importing AI libraries
-auto_instrument()
-
-from litellm import completion
-import openai
-
-# Set tenant for multi-tenant applications
-set_tenant_id("tenant-123")
-
-# Basic GenAI operation tracking
-with context_overlay(GenAIOperation.CHAT, attributes={"user.id": "123"}):
-    response = completion(model="gpt-4", messages=[{"role": "user", "content": "Hello"}])
-
-# Manual metrics and spans
-@record_metrics(module="myapp", operation="data_processing")
-def process_data(data):
-    add_span_attribute("data.size", len(data))
-    # Processing logic
-    return processed_data
-```
+## Licensing
+
+Copyright 2026 SAP SE or an SAP affiliate company and Cloud SDK Python contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/cloud-sdk-python)
