(incubator-grails-gradle-publish) 04/04: chore: update README.md

[jd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jdaugherty pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/incubator-grails-gradle-publish.git

commit b159ad300c1c666140d1c910c474026ae94347f5
Author: James Daugherty <jd...@jdresources.net>
AuthorDate: Tue Jul 29 09:12:24 2025 -0400

    chore: update README.md
---
 README.md | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b809625..caeb1a7 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,13 @@ Grails Publish is a Gradle plugin to ease publishing with the maven publish plug
 Artifacts published by this plugin include sources, the jar file, and a javadoc jar that contains both the groovydoc &
 javadoc.
 
+Limitations
+---
+
+This plugin currently acts as a wrapper around the `maven-publish` & `nexus-publish` plugins. There are known
+limitations with the `nexus-publish` plugin - specifically, when it can be applied in multiproject setups. Check out the
+functional test resources for specific scenarios that work and do not work.
+
 Setup
 ---
 If obtaining the source from the source distribution and you intend to build from source, you also need to download and
@@ -55,9 +62,15 @@ buildscript {
 }
 ```
 
-Usage
+And then apply the plugin:
+
+```groovy
+apply plugin: 'org.apache.grails.gradle.grails-publish'
+```
+
+Configuration
 ---
-Example Usage:
+Example Configuration:
 
     grailsPublish {
         websiteUrl = 'http://foo.com/myplugin'
@@ -104,4 +117,5 @@ The credentials and connection url must be specified as a project property or an
     NEXUS_PUBLISH_STAGING_PROFILE_ID
 
 By default, the release or snapshot state is determined by the project.version or projectVersion gradle property. To
-override this behavior, use the environment variable `GRAILS_PUBLISH_RELEASE` to decide if it's a release or snapshot.
+override this behavior, use the environment variable `GRAILS_PUBLISH_RELEASE` with a boolean value to decide if it's a
+release or snapshot.