Merge pull request #2 from pmalirz/README

Add initial README.md

README.md

@@ -0,0 +1,78 @@
+# intest-gradle-plugin
+
+## Overview
+
+**intest-gradle-plugin** is a Gradle plugin that simplifies the configuration of integration tests. The plugin adds
+the `intest` task to a Gradle project's configuration, which helps to avoid manual configuration of integration tests.
+This follows the convention over configuration principle.
+
+## Usage
+
+The `intest` task can be executed using the following command:
+
+```bash
+gradlew intest
+```
+
+Although the `intest` task should run after the `test` task, it does not run automatically by default. You may need to
+execute it explicitly or configure the `intest` task to be run automatically immediately after the `test` phase.
+
+The reason why the `intest` task does not run automatically by default is that integration tests are usually much
+heavier to run. Therefore, it is wise to make a conscious decision on when to execute them.
+
+## Adding the Plugin to Your Project
+
+`settings.gradle.kts`
+
+```kotlin
+pluginManagement {
+    plugins {
+        id("pl.malirz.intest") version "{version}"
+    }
+    repositories {
+        gradlePluginPortal(
+            mavenCentral()
+                    mavenLocal ()
+    }
+}
+```
+
+`build.gradle.kts`
+
+```kotlin
+plugins {
+    `java-gradle-plugin`
+    id("pl.malirz.intest")
+}
+
+tasks.withType<Test> {
+    useJUnitPlatform()
+    testLogging.setShowStandardStreams(true)
+}
+
+tasks.getByName<Test>("intest") {
+    useJUnitPlatform()
+    testLogging.setShowStandardStreams(true)
+}
+```
+
+Folders structure in your project
+
+```
+project
+│   build.gradle.kts
+│   settings.gradle.kts
+│
+└───src
+    └───main
+    └───test
+    └───intest
+```
+
+Once the *intest-gradle-plugin* is enabled in the project the IDE (e.g. IntelliJ) automatically discovers the `intest` folder as a source folder. You
+can start adding there integration tests as per your preference, Java, Kotlin or Groovy.
+
+## Conclusion
+
+*intest-gradle-plugin* makes it easier to configure integration tests in your Gradle project. By adding the plugin,
+you can avoid manual configuration and follow the convention over configuration principle.