diff --git a/real.README.md b/real.README.md index 45053b1..389c3e2 100644 --- a/real.README.md +++ b/real.README.md @@ -5,9 +5,50 @@ _project_summary_ [![The GitLab CI pipeline status badge of the project's `main` branch](https://gitlab.com/_namespace_/_project_/badges/main/pipeline.svg?ignore_skipped=true "Click here to check out the comprehensive status of the GitLab CI pipelines")](https://gitlab.com/_namespace_/_project_/-/pipelines) [![GitHub Actions workflow status badge](https://github.com/_namespace_/_project_/actions/workflows/check-potential-problems.yml/badge.svg "GitHub Actions workflow status")](https://github.com/_namespace_/_project_/actions/workflows/check-potential-problems.yml) [![pre-commit enabled badge](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white "This project uses pre-commit to check potential problems")](https://pre-commit.com/) [![REUSE Specification compliance badge](https://api.reuse.software/badge/gitlab.com/_namespace_/_project_ "This project complies to the REUSE specification to decrease software licensing costs")](https://api.reuse.software/info/gitlab.com/_namespace_/_project_) + + +## Example playbooks + +Refer to the files under [the playbooks directory](playbooks/) for example playbooks. + +Note that you need to [create a self-referencing symbolic link](playbooks/roles/#creating-the-namespace-name-pseudo-role) for the playbooks to work if you want to run the playbooks directly in this role. + + + ## Licensing