Give the README.md a lick of paint 🎨

.github/PUBLISHING.md → PUBLISHING.md

@@ -4,15 +4,15 @@ This page describes how to publish a new version of plugin and all related artif
 
 Steps:
 
-1. Create a PR with version increment in [gradle.properties](../gradle.properties) and in [documentation](../README.adoc). Please follow [semver guidelines](https://semver.org/):
+1. Create a PR with version increment in [gradle.properties](./gradle.properties) and in [documentation](./README.md). Please follow [semver guidelines](https://semver.org/):
    1. If there are breaking `.api` files - increment the major version (e.g. from `x.y.z` to `x+1.0.0`)
    2. If current version is compatible with previous one and there are some notable changes - please increment the minor one (e.g. from `x.y.z` to `x.y+1.0`)
    3. Otherwise - please increment the patch version (e.g. from `x.y.z` to `x.y.z+1`).
 2. Receive API Key and Secret from the portal (please
    follow [the documentation](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html)) and add them into the project secrets.
 3. Run publication workflows:
    1. Navigate to [Actions](https://github.com/Citi/gradle-helm-plugin/actions/workflows/) and locate
-   the [publish workflow](./workflows/publish.yaml) and [publish documentation one](./workflows/publish.yaml). GitHub
+   the [publish workflow](./.github/workflows/publish.yaml) and [publish documentation one](./.github/workflows/publish.yaml). GitHub
    documentation: https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow
    2. Run both workflows
-4. Release [the version on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github).
+4. Release [the version on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github).

README.md

@@ -0,0 +1,92 @@
+<div align="center">
+  <a href="https://github.com/citi">
+    <img src="https://github.com/citi.png" alt="Citi" width="80" height="80">
+  </a>
+
+  <h3 align="center">Citi/gradle-helm-plugin</h3>
+
+  <p align="center">
+    A suite of Gradle Plugins for <br />building, publishing and managing <a href="https://www.helm.sh">Helm</a> Charts
+    <br />
+  </p>
+
+  <p align="center">
+    <a href="https://citi.github.io/gradle-helm-plugin/"><img src="https://img.shields.io/badge/read%20our%20documentation-0f1632"></a>
+    <a href="https://plugins.gradle.org/plugin/com.citi.helm/2.1.0"><img src="https://img.shields.io/gradle-plugin-portal/v/com.citi.helm?versionPrefix=2.1.0&colorA=0f1632&colorB=255be3" /></a>
+    <a href="./LICENSE"><img src="https://img.shields.io/github/license/citi/gradle-helm-plugin?label=license&colorA=0f1632&colorB=255be3" /></a>
+
+  </p>
+</div>
+
+<br />
+
+## Features
+
+- Gradle task types for common Helm CLI commands
+
+- Build, package and publish Helm Charts using a declarative Gradle DSL
+
+- Resolve placeholders like ${chartVersion} from chart source files before packaging
+
+- Resolve dependencies between charts using Gradle artifact dependencies
+
+- Install, upgrade and uninstall releases to/from a Kubernetes cluster
+
+## Quick Start
+
+Add `com.citi.helm` to your Gradle project:
+
+```gradle
+plugins {
+    id 'com.citi.helm' version '2.1.0'
+}
+```
+
+```gradle
+plugins {
+    id("com.citi.helm") version "2.1.0"
+}
+```
+
+```gradle
+📂 (project root)
+    📂 src
+        📂 main
+            📂 helm
+                📂 templates
+                    📄 ...
+                📄 Chart.yaml
+                📄 values.yaml
+```
+
+## Requirements
+
+- Gradle 7 or higher
+
+- JDK 1.8 or higher (for running Gradle)
+
+- Helm command-line client 3.+
+
+## Contributing
+
+Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**.
+
+We welcome you to:
+
+- Fix typos or touch up documentation
+- Share your opinions on [existing issues](https://github.com/citi/gradle-helm-plugin/issues)
+- Help expand and improve our library by [opening a new issue](https://github.com/citi/gradle-helm-plugin/issues/new)
+
+Please review our [community contribution guidelines](https://github.com/Citi/.github/blob/main/CONTRIBUTING.md) and [functional contribution guidelines](./CONTRIBUTING.md) to get started 👍
+
+## Code of Conduct
+
+We are committed to making open source an enjoyable and respectful experience for our community. See [`CODE_OF_CONDUCT`](https://github.com/Citi/.github/blob/main/CODE_OF_CONDUCT.md) for more information.
+
+## License
+
+This project is distributed under the [MIT License](https://opensource.org/license/mit). See [`LICENSE`](./LICENSE) for more information.
+
+## Contact
+
+If you have a query or require support with this project, [raise an issue](https://github.com/Citi/gradle-helm-plugin/issues). Otherwise, reach out to [email protected].

helm-plugin/src/test/kotlin/com/citi/gradle/plugins/helm/PluginVersionSynchronization.kt

@@ -13,9 +13,9 @@ class PluginVersionSynchronization {
     @Test
     fun pluginVersionShouldBeTheSameWithDocumentation() {
         val pluginVersion = getPluginVersion()
-        val expectedDocumentationLine = ":version: $pluginVersion"
+        val expectedDocumentationLine = "$pluginVersion"
 
-        val readmeFile = File("../README.adoc").absoluteFile.readText()
+        val readmeFile = File("../README.md").absoluteFile.readText()
 
         readmeFile shouldContain expectedDocumentationLine
     }