Change: adjusted README.md #26

README.md

@@ -10,13 +10,13 @@
 *** https://www.markdownguide.org/basic-syntax/#reference-style-links
 -->
 
-[![k3s][k3s-shield]][k3s-url]
-[![terraform][terraform-shield]][terraform-url]
-[![cloudflare][cloudflare-shield]][cloudflare-url]
 [![pre-commit][pre-commit-shield]][pre-commit-url]
-[![renovate][renovate-shield]][renovate-url]
+[![renovate][renovate-shield]][renovate-dashboard-url]
 [![taskfile][taskfile-shield]][taskfile-url]
 [![commits][commits-shield]][commits-url]
+[![k3s][k3s-shield]][k3s-url]
+[![terraform][terraform-shield]][terraform-url]
+[![cloudflare][cloudflare-shield]][cloudflare-url]
 
 <!-- PROJECT LOGO -->
 <!--<br />
@@ -27,8 +27,9 @@
 
 # Kubernetes GitOps Cluster
 
-- :briefcase: managed with Flux2 and Terraform
-- :robot: updated by RenovateBot
+- 💼 managed with [Flux2][flux-url] and [Terraform][terraform-url]
+- 🤖 updated by [RenovateBot][renovate-url]
+- 🔐 secured by [Let's Encrypt][letsencrypt-url]
 
 <br />
 <!-- TABLE OF CONTENTS -->
@@ -38,7 +39,10 @@
     <li>
       <a href="#about-the-project">About The Project</a>
       <ul>
-        <li><a href="#toolbox-tools-and-technologies">:toolbox:&nbsp;Tools and Technologies</a></li>
+        <li><a href="#goals">Goals</a></li>
+        <li><a href="#tools-tools-and-technologies">:toolbox:&nbsp;Tools and Technologies</a></li>
+      </ul>
+      <li><a href="#map-overview">🗺️ Overview</a></li>
       </ul>
     </li>
     <li>
@@ -53,37 +57,38 @@
     <li><a href="#detective-troubleshooting">:detective:&nbsp; Troubleshooting</a></li>
   </ol>
 </details>
-
 <br />
 
 <!-- ABOUT THE PROJECT -->
 
 ## About The Project
 
-This is a private project. I want to share it with you. I started my journey with kuberntes and GitOps a few years ago.
+👋 Hello and welcome to my project. This is a private project heavily inspired by the great [k8s-at-home][k8s-at-home-url] community. I want to share my work and findings but also my frustrations with you.
 
-Goals:
+### Goals
 
 - Automate my home and home infrastructure.
 - Learn new things everyday.
 - Challenge myself.
-- Share my findings and work with you cause knowledge should be free and humans should not do same things twice.
+- Share my findings and work with you. (cause knowledge should be free and humans should not do same things twice)
 - More time for new/other things. :nerd_face:
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-### :toolbox:&nbsp; Tools and Technologies
+### :tools:&nbsp; Tools and Technologies
 
 Here is the list of tools and technologies I am using in this project.
 
-- [k3s](https://k3s.io/)
-- [Flux2](https://fluxcd.io/)
-- [Terraform](https://www.terraform.io/)
+- [k3s][k3s-url]
+- [Flux2][flux-url]
+- [Terraform][terraform-url]
 - [Ubuntu](https://ubuntu.com/)
 - [Cloudflare](https://www.cloudflare.com/)
 - [RenovateBot](https://www.whitesourcesoftware.com/free-developer-tools/renovate/)
 - [GitHub](https://github.com)
 
+### :map:&nbsp; Overview
+
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- GETTING STARTED -->
@@ -159,11 +164,15 @@ example:
 [k3s-shield]: https://img.shields.io/badge/k3s-v1.23.3-ffc61c?style=for-the-badge&logo=kubernetes&logoColor=white
 [pre-commit-url]: https://github.com/pre-commit/pre-commit
 [pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge
-[renovate-url]: https://app.renovatebot.com/dashboard
+[renovate-dashboard-url]: https://app.renovatebot.com/dashboard
 [renovate-shield]: https://img.shields.io/badge/renovate-enabled-brightgreen?logo=renovatebot&style=for-the-badge
 [taskfile-url]: https://taskfile.dev/
-[taskfile-shield]: https://img.shields.io/badge/Task-Enabled-brightgreen?logoColor=white&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAEeElEQVR4Xu2bzU8TQRjGZ7atRQKaGAVRhBakNbYkGEPVE5IoJh403rxIgpgYwOBHPBgPxoTwDyiCelIx8SwqxhilEj9ihBCDhK8g0IIiEAqlgLi1YxZdU2DpzszOfhy2174z7/P+5nlntrtbCHT83BzqQRyAH6sc7v16yYB6JO6aCXX4Q+MFy3InR1Or0jwRrfVoCgAhZKkf7osmKrLK4dZUk2bJ7gT6UTQWw1pgCGCg0uHKxgpWGKQ6gM6Z0IPW0PgpGp1auEFVALeGehFN4SvHqAlCFQB3RwYQH03Y6sRcOABeVTjch4gHygxgCiD4c+5o09jIM9Yi4+fbPfjNVlxczIwuMwCs7I4Lj1VbKAbQOPqVD/O8FVc4yzgIwcPKbDfVBivqoAaAEDpYP9zXwrIg2rmUuIEKgNZ2xwEDOQ5UZuUR10M04PnUD/Q1PI2jR7eYJA6WlWe57uEKwAIwiFBS83DfAu6kRojDbQtZAEa0OwlgORBrAngyFmwL/JzfS5LMqLGpVq60NDOvUUqfJIDL3e3IuT7FqPVQ6ZqN8uDKTu+qeiUB7GxpWrqGv+h0UyUz2qAvs3837ob8fWQAhEEchOC8w2W0mrD0dM1Og/hfY1QAxEynM3PARpsNK7HeQYuxGOifC6+SoQiAOJvR20K0u9QiMAEgTJzEcaAiO0/vhV6WvzsyA36jxLcfmAEQM5/NygXJFl1+B/0vPopioCey2u6qOmDl5Hq1RSK7awpASLbBagPlO3I0aYveSBjwCO8Ga7wg5i0gVe0FpxvIXl8rwES66poDEBIKW9ElxhdRSgoXIWjigHjiuckp4Fj6dgXrDUBgYQ6Eo7yiOXQDICa+4HABCMkaQ3CRcCXH8qO5A2hPCxZ21/wUwF0pT0oqKNmyTTJ8ZGEOTDOyu2EBiMIuOXcB9O+nitAcnYztbngAgsAYQqBky1ZVj01djkHcdhDiDm9OJwlXFKv7Jiil3gRgOsBsAUV9TTLY3ANoboqSEKaJNTdBcxM0N0GazqEaY26C5iZI8WiMymsEg8xTwDwFDHgKCA4+0daKtLhJoUULWCBsqvP6jkt1puydSvFdAYK2JgpVFQCEoMHrS1ijLAChmgl+oejA25d+osowg9UCkD45b7uO8UotFgCxFs+bp0h49s7ywxqADXKDN7yF2M/oiACIhbNsC5YApK705BaLCoAw6f1A/9Wage5auQRy37MAcM7rTPXANKr/G1EDEAsrePcCRX4tytW55vdKAFgg/F7n9Uk/ZMBUpBiA0ragBUBjd6pjEBPkUljz+Oij6q72kyRjSAFsAjCrNt8XJMmRKJaZA+KTOF4/RlbMh6G4ACx2O6hzFTDXy3zCeBA4pwUOAFZ2V70FpBKc+fzB75+aKFrLhokAbLavK6tx7cF+9Z2mLVR1AI4bpABACGP1Xp+FpiDSMZoBEIS9R8H1pf6O+XiRKwGoaXddWkAqaXXnJ7558vvSC4YigAy7veKaq+A26QoqjdfUASvF5rY0oSNpGaDeU6ibjj9v/5xQDsUWRgAAAABJRU5ErkJggg==
+[taskfile-shield]: https://img.shields.io/badge/Taskfile-Enabled-brightgreen?logoColor=white&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAEeElEQVR4Xu2bzU8TQRjGZ7atRQKaGAVRhBakNbYkGEPVE5IoJh403rxIgpgYwOBHPBgPxoTwDyiCelIx8SwqxhilEj9ihBCDhK8g0IIiEAqlgLi1YxZdU2DpzszOfhy2174z7/P+5nlntrtbCHT83BzqQRyAH6sc7v16yYB6JO6aCXX4Q+MFy3InR1Or0jwRrfVoCgAhZKkf7osmKrLK4dZUk2bJ7gT6UTQWw1pgCGCg0uHKxgpWGKQ6gM6Z0IPW0PgpGp1auEFVALeGehFN4SvHqAlCFQB3RwYQH03Y6sRcOABeVTjch4gHygxgCiD4c+5o09jIM9Yi4+fbPfjNVlxczIwuMwCs7I4Lj1VbKAbQOPqVD/O8FVc4yzgIwcPKbDfVBivqoAaAEDpYP9zXwrIg2rmUuIEKgNZ2xwEDOQ5UZuUR10M04PnUD/Q1PI2jR7eYJA6WlWe57uEKwAIwiFBS83DfAu6kRojDbQtZAEa0OwlgORBrAngyFmwL/JzfS5LMqLGpVq60NDOvUUqfJIDL3e3IuT7FqPVQ6ZqN8uDKTu+qeiUB7GxpWrqGv+h0UyUz2qAvs3837ob8fWQAhEEchOC8w2W0mrD0dM1Og/hfY1QAxEynM3PARpsNK7HeQYuxGOifC6+SoQiAOJvR20K0u9QiMAEgTJzEcaAiO0/vhV6WvzsyA36jxLcfmAEQM5/NygXJFl1+B/0vPopioCey2u6qOmDl5Hq1RSK7awpASLbBagPlO3I0aYveSBjwCO8Ga7wg5i0gVe0FpxvIXl8rwES66poDEBIKW9ElxhdRSgoXIWjigHjiuckp4Fj6dgXrDUBgYQ6Eo7yiOXQDICa+4HABCMkaQ3CRcCXH8qO5A2hPCxZ21/wUwF0pT0oqKNmyTTJ8ZGEOTDOyu2EBiMIuOXcB9O+nitAcnYztbngAgsAYQqBky1ZVj01djkHcdhDiDm9OJwlXFKv7Jiil3gRgOsBsAUV9TTLY3ANoboqSEKaJNTdBcxM0N0GazqEaY26C5iZI8WiMymsEg8xTwDwFDHgKCA4+0daKtLhJoUULWCBsqvP6jkt1puydSvFdAYK2JgpVFQCEoMHrS1ijLAChmgl+oejA25d+osowg9UCkD45b7uO8UotFgCxFs+bp0h49s7ywxqADXKDN7yF2M/oiACIhbNsC5YApK705BaLCoAw6f1A/9Wage5auQRy37MAcM7rTPXANKr/G1EDEAsrePcCRX4tytW55vdKAFgg/F7n9Uk/ZMBUpBiA0ragBUBjd6pjEBPkUljz+Oij6q72kyRjSAFsAjCrNt8XJMmRKJaZA+KTOF4/RlbMh6G4ACx2O6hzFTDXy3zCeBA4pwUOAFZ2V70FpBKc+fzB75+aKFrLhokAbLavK6tx7cF+9Z2mLVR1AI4bpABACGP1Xp+FpiDSMZoBEIS9R8H1pf6O+XiRKwGoaXddWkAqaXXnJ7558vvSC4YigAy7veKaq+A26QoqjdfUASvF5rY0oSNpGaDeU6ibjj9v/5xQDsUWRgAAAABJRU5ErkJggg==
 [cloudflare-url]: https://dash.cloudflare.com/
 [cloudflare-shield]: https://img.shields.io/badge/cloudflare-dns-F38020?logo=cloudflare&style=for-the-badge&logoColor=white
 [commits-url]: https://github.com/tyriis/flux.k3s.cluster/commits/main
 [commits-shield]: https://img.shields.io/github/last-commit/tyriis/flux.k3s.cluster?logo=github&style=for-the-badge
+[letsencrypt-url]: https://letsencrypt.org/
+[renovate-url]: https://github.com/renovatebot/renovate
+[flux-url]: https://fluxcd.io/
+[k8s-at-home-url]: https://k8s-at-home.com/