ADD: Readme

README.md

@@ -0,0 +1,26 @@
+# Homepage Configuration
+
+This repository contains the configuration files for a [Homepage](https://gethomepage.dev/) instance, a modern, fully static, fast, secure, and highly customizable application dashboard.
+
+## Configuration Overview
+
+The configuration is split across several YAML files, each responsible for a different aspect of the dashboard.
+
+*   **`services.yaml`**: Defines the main services and applications displayed on the dashboard. Each service can have a name, description, icon, link, and an associated widget.
+*   **`widgets.yaml`**: Configures standalone informational widgets, such as the weather forecast (`openmeteo`) and a digital clock (`datetime`).
+*   **`bookmarks.yaml`**: Manages the bookmarks section, organized into groups for easy access to frequently used sites.
+*   **`docker.yaml`**: Sets up the connection to Docker hosts, allowing Homepage to display container statuses and provide quick actions.
+*   **`settings.yaml`**: Contains global settings for the dashboard, such as the visual theme (`dark`).
+*   **`.env`**: Stores all secrets, API keys, and environment-specific URLs. This file is intentionally excluded from version control by `.gitignore` to keep sensitive information secure.
+*   **`.env.example`**: A template file that shows which environment variables are required for the configuration to work correctly.
+
+### Using Environment Variables
+
+This configuration makes extensive use of variables to separate secrets and environment-specific values from the main configuration. In files like [`services.yaml`](homepage/services.yaml), you will see placeholders like `{{HOMEPAGE_VAR_PROXMOX_URL}}`.
+
+Homepage automatically replaces these placeholders with the corresponding values defined in the [`.env`](homepage/.env) file. This approach allows for a clean, portable, and secure configuration, as sensitive data is not hardcoded and can be easily managed without altering the core YAML files.
+
+To use this configuration, you would need to:
+1.  Copy [`.env.example`](homepage/.env.example) to `.env`.
+2.  Fill in the `.env` file with your specific URLs, API keys, and credentials.
+3.  Ensure your Homepage instance is configured to use this directory for its configuration.