diff --git a/test/v2-migration-tests/pom.xml b/test/v2-migration-tests/pom.xml
index 0066b81536e8..b063113456c2 100644
--- a/test/v2-migration-tests/pom.xml
+++ b/test/v2-migration-tests/pom.xml
@@ -96,7 +96,7 @@
software.amazon.awssdk
v2-migration
- ${project.version}-PREVIEW
+ ${project.version}
test
diff --git a/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/GradleProjectTest.java b/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/GradleProjectTest.java
index 2a77a993e5cd..299a9677f9ac 100644
--- a/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/GradleProjectTest.java
+++ b/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/GradleProjectTest.java
@@ -74,7 +74,7 @@ static void setUp() throws IOException {
Files.setPosixFilePermissions(gradlew, perms);
- replaceVersion(gradleActual.resolve("init.gradle"), getMigrationToolVersion() + "-PREVIEW");
+ replaceVersion(gradleActual.resolve("init.gradle"), getMigrationToolVersion());
}
private static void deleteTempDirectories() throws IOException {
diff --git a/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/MavenTestBase.java b/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/MavenTestBase.java
index a7b6a5befe1d..a859c879f630 100644
--- a/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/MavenTestBase.java
+++ b/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/MavenTestBase.java
@@ -53,8 +53,7 @@ protected static void verifyTransformation() throws IOException {
// pin version since updates have broken tests
String rewriteMavenPluginVersion = "6.17.0";
addAll(rewriteArgs, "mvn", "org.openrewrite.maven:rewrite-maven-plugin:" + rewriteMavenPluginVersion + ":run",
- "-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:"+ getMigrationToolVersion() + "-PREVIEW",
- recipeCmd);
+ "-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:"+ getMigrationToolVersion(), recipeCmd);
run(mavenActual, rewriteArgs.toArray(new String[0]));
FileUtils.deleteDirectory(mavenActual.resolve("target").toFile());
diff --git a/v2-migration/README.md b/v2-migration/README.md
index 30a16d51180f..60302e1fdec2 100755
--- a/v2-migration/README.md
+++ b/v2-migration/README.md
@@ -1,11 +1,29 @@
# AWS SDK for Java v2 Migration Tool
## Description
-This modules contains [OpenRewrite][open-rewrite] recipes to automate migration from the AWS SDK for Java v1 to the AWS SDK for Java v2.
+This module contains [OpenRewrite][open-rewrite] recipes to automate migration from the AWS SDK for Java v1 to the
+AWS SDK for Java v2.
+
+While the majority of v1 code is supported by recipes that transform to the v2 equivalent, there are some classes and
+methods not covered by the migration tool. For these classes and methods, refer to our
+[Developer Guide][developer-guide-steps] and [API Reference][api-reference-v2] to manually migrate your code.
## Usage
-For steps on performing the migration, see our [Developer Guide][developer-guide].
+For detailed steps on using the tool, see our [Developer Guide][developer-guide].
+
+### Maven Project
+
+To transform a Maven project, run the following command from your project root directory:
+
+```
+mvn org.openrewrite.maven:rewrite-maven-plugin:6.17.0 \
+ -Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:2.34.0 \
+ -Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
+```
+
+**Note:** Newer OpenRewrite versions may not be compatible. If errors occur during the transforms, specify the
+[SDK supported version][maven-plugin-version], e.g., `6.17.0`, and run the command again.
## Development
@@ -31,4 +49,7 @@ code and ensures it compiles.
[open-rewrite]: https://docs.openrewrite.org/
[rewrite-test]: https://docs.openrewrite.org/authoring-recipes/recipe-testing#rewritetest-interface
[v2-migration-tests]: ../test/v2-migration-tests
-[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html
\ No newline at end of file
+[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html
+[developer-guide-steps]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-steps.html
+[api-reference-v2]: https://sdk.amazonaws.com/java/api/latest/index.html
+[maven-plugin-version]: https://github.com/aws/aws-sdk-java-v2/blob/master/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/MavenTestBase.java#L54
\ No newline at end of file
diff --git a/v2-migration/pom.xml b/v2-migration/pom.xml
index 478ce4054c0b..df04e219f715 100644
--- a/v2-migration/pom.xml
+++ b/v2-migration/pom.xml
@@ -26,7 +26,7 @@
v2-migration
- ${awsjavasdk.version}-PREVIEW
+ ${awsjavasdk.version}
AWS Java SDK :: V2 Migration
Contains OpenRewrite recipes to help users migrate from the AWS SDK for Java v1 to the AWS SDK for Java v2