Update docs

Author: Nuckal777

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+<!--
+# SPDX-FileCopyrightText: Copyright 2024 SAP SE or an SAP affiliate company and cobaltcore-dev contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+-->
+
+# Contributing
+
+## Code of Conduct
+
+All members of the project community must abide by the [SAP Open Source Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md).
+Only by respecting each other we can develop a productive, collaborative community.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](REUSE.toml).
+
+## Engaging in Our Project
+
+We use GitHub to manage reviews of pull requests.
+
+* If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)
+* Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.
+* The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.
+
+## Steps to Contribute
+
+Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.
+
+If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.
+
+## Contributing Code or Documentation
+
+You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue.
+
+The following rule governs code contributions:
+
+* Contributions must be licensed under the [Apache 2.0 License](./LICENSE).
+* Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
+* Contributions must follow our [guidelines on AI-generated code](https://github.com/SAP/.github/blob/main/CONTRIBUTING_USING_GENAI.md) in case you are using such tools.
+
+## Issues and Planning
+
+* We use GitHub issues to track bugs and enhancement requests.
+* Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.

README.md

@@ -6,4 +6,68 @@ SPDX-License-Identifier: Apache-2.0
 
 # cloud-profile-sync
 
-Automatically updates images in a Gardener `CloudProfile` based on changes in image sources, such as tags in an OCI registry.
+## About this project
+
+Automatically updates properties of a [Gardener](https://github.com/gardener/gardener) `CloudProfile`, e.g. `machineImages` based on various sources, such as tags in an OCI repository.
+
+## Requirements and Setup
+
+- a recent `go` compiler
+- GNU `make`
+- `docker` to build the container
+
+The tests can be run with `make check`.
+
+## Usage
+
+Initially, apply the `ManagedCloudProfile` CRD to your virtual garden apiserver.
+Then a `ManagedCloudProfile` can be created:
+```yaml
+apiVersion: cloudprofilesync.cobaltcore.dev/v1alpha1
+kind: ManagedCloudProfile
+metadata:
+  name: cloud-profile-name
+spec:
+  cloudProfile:
+    # regular CloudProfile spec, but some fields are optional
+    # to enable fully automatic management
+  machineImageUpdates: # configures automatic management of machineImages
+  - imageName: gardenlinux
+    provider: # provider updates the providerConfig about images
+      ironcoreMetal: # updates gardener-extension-ironcore-metal
+        registry: docker.io # hostname of registry to pull the image from
+        repository: gardenlinux/gardenlinux  # repository to pull the image from
+    source: # source used to check for image
+      oci: # OCI registry source
+        registry: docker.io # hostname of registry
+        repository: gardenlinux/gardenlinux # repository to watch
+        insecure: false # disables HTTP
+        username: "" # username for basic auth
+        password: "" # reference to a secret to lookup a password for basic auth
+          name: ""
+          namespace: ""
+          key: ""
+```
+Reconciliation takes care of creating the respective `CloudProfile`.
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cobaltcore-dev/cloud-profile-sync/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).
+
+## Security / Disclosure
+
+If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cobaltcore-dev/cloud-profile-sync/security/policy) on how to report it.
+Please do not create GitHub issues for security-related doubts or problems.
+
+## Code of Conduct
+
+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.
+
+## Licensing
+
+Copyright 2025 SAP SE or an SAP affiliate company and <your-project> 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/cobaltcore-dev/cloud-profile-sync).