From 904d826d1659624bae500da230010d08f20ab2bf Mon Sep 17 00:00:00 2001
From: Simon Templer <simon@wetransform.to>
Date: Wed, 27 Nov 2024 10:23:05 +0100
Subject: [PATCH] docs: update README related to changes to release and
 versioning

---
 README.md | 32 ++++++++++++--------------------
 1 file changed, 12 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index f9d2fca..f05294b 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,9 @@ For a quick start, check out the (outdated) [sample project on GitHub](https://g
 Usage
 -----
 
-The simplest way to apply the plugin to your Gradle build is using the latest release hosted on Maven Central:
+The simplest way to apply the plugin to your Gradle build is using the latest release on the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/org.standardout.bnd-platform).
+
+The plugin is also hosted on Maven Central:
 
 ```groovy
 buildscript {
@@ -30,13 +32,15 @@ buildscript {
 		mavenCentral()
 	}
 	dependencies {
-		classpath 'org.standardout:bnd-platform:3.0.1'
+		classpath 'org.standardout:bnd-platform:<version>'
 	}
 }
 
 apply plugin: 'org.standardout.bnd-platform'
 ```
 
+You can look up the latest release version in the [GitHub releases](https://github.com/stempler/bnd-platform/releases).
+
 Alternatives are including the repository content in the **buildSrc** folder as done in the [sample project](https://github.com/stempler/bnd-platform-sample) or by installing the plugin to your local Maven repository using `gradlew install` and adding it as dependency to your build script via `mavenLocal()` repository.
 
 Snapshot versions are available in the related sonatype repository:
@@ -50,13 +54,18 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'org.standardout:bnd-platform:3.1.0-SNAPSHOT'
+        classpath 'org.standardout:bnd-platform:<version>'
     }
 }
 
 apply plugin: 'org.standardout.bnd-platform'
 ```
 
+The latest snapshot version can be found in the [Sonatype repository](https://oss.sonatype.org/content/repositories/snapshots/org/standardout/bnd-platform/).
+
+If changes were made after the last release, the snapshot version is the last release version with the minor version number increased by one and the qualifier set to `-SNAPSHOT`.
+For example, for the 3.1.0 release the snapshot version would be 3.2.0-SNAPSHOT.
+
 
 ### Tasks
 
@@ -521,23 +530,6 @@ platform {
 }
 ```
 
-
-
-Release
--------
-
-Releases are currently not done by the CI but manually.
-
-Steps are:
-
-1. Change version to release version
-2. Adapt changelog
-3. Create tag
-4. Publish release to Maven Central (`./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository`)
-5. Publish release to Gradle Plugin Portal
-6. Change version to new snapshot
-
-
 License
 -------