test: Flesh out the readme a little bit

Author: zml2008

mammoth-test/src/main/java/net/kyori/mammoth/test/TestContext.java

@@ -90,6 +90,7 @@ public final class TestContext {
    * Copy a resource from the {@code <testName>/in/} directory to the run directory with no changes.
    *
    * @param name the input relative to the test's directory
+   * @throws IOException if an error occurs writing the input file to disk
    * @since 1.1.0
    */
   public void copyInput(final @NotNull String name) throws IOException {
@@ -101,6 +102,7 @@ public void copyInput(final @NotNull String name) throws IOException {
    *
    * @param fromName the name relative to the input
    * @param toName the name to use in the test's output directory
+   * @throws IOException if an error occurs writing the input file to disk
    * @since 1.1.0
    */
   public void copyInput(final @NotNull String fromName, final @NotNull String toName) throws IOException {
@@ -142,7 +144,7 @@ public void copyInput(final @NotNull String fromName, final @NotNull String toNa
 
   /**
    * Expect that the contents of the output file {@code fileName} is equal to
-   * the contents of the resource at  {@code <testName>/out/<resourceName>}.
+   * the contents of the resource at {@code <testName>/out/<resourceName>}.
    *
    * @param resourceName the name of the expected resource
    * @param fileName the name of the actual output file

readme.md

@@ -10,16 +10,27 @@ The main component of `mammoth` is utility functions for developing Gradle plugi
 
 Mammoth provides test fixtures to enable functional testing of Gradle plugins. This architecture is designed for Java tests using JUnit 5, with the buildscripts for tested builds stored as classpath resources. This stands in contrast to Groovy functional tests, where the buildscript is written as a string directly in the test class.
 
+### Annotations
+
+Annotation                  | Purpose
+--------------------------- | ------------------------------------------
+`@GradleFunctionalTest` | Mark a test method as a functional test
+`@GradleParameters`      | Pass parameters to every Gradle invocation
+`@TestVariant`            | Declare a single variant of a tent, with a specific gradle version and extra parameters. Repeatable
+`@TestVariantResource`  | Declare a classpath resource to read additional variants from. Each line in the file is one variant, in the format `<version>[:<args...>]`
+
+### Usage
+
 <details>
 <summary>Example</summary>
 
-Assuming there are files at `src/test/resources/com/example/myplugin/simpleBuild/in/build.gradle.kts` and `src/test/resources/com/example/myplugin/simpleBuild/in/settings.gradle.kts`, the following sets up a simple test that will run on both Gradle 6.9 and 7.1:
+Assuming there are files at `src/test/resources/com/example/myplugin/simpleBuild/in/build.gradle` and `src/test/resources/com/example/myplugin/simpleBuild/in/settings.gradle`, the following sets up a simple test that will run on both Gradle 6.9 and 7.1:
 
 **com/example/myplugin/MyPluginTest.java**:
 
 ```java
 /**
- * A <em>meta-annotation containing our test configuration.</em>
+ * A <em>meta-annotation</em> containing our test configuration.
  */
 @GradleFunctionalTest
 @GradleParameters({"--warning-mode", "all", "--stacktrace"}) // parameters for all variants
@@ -37,10 +48,10 @@ public @interface MyPluginTest {
 
 class MyPluginFunctionalTest {
 
-  @SpongeGradleFunctionalTest
+  @MyPluginTest
   void simpleBuild(final TestContext ctx) {
-    ctx.copyInput("build.gradle.kts");
-    ctx.copyInput("settings.gradle.kts");
+    ctx.copyInput("build.gradle");
+    ctx.copyInput("settings.gradle");
 
     final BuildResult result = ctx.build("build"); // or anoher