First, add the Maven repository to your build.gradle file:

repositories {
    maven { url "https://repo.william278.net/releases" }
}

Then, add the dependency itself. Replace VERSION with the latest release version. (e.g. 2.0.6). If you want to target pre-release "snapshot" versions (not recommended), you should use the /snapshots repository instead.

dependencies {
    implementation "net.william278:annotaml:VERSION"
}

import net.william278.annotaml.annotations.*;

@YamlConfig
public class MyConfig {

    // Annotaml supports most basic data structures, but *does not support custom classes for the sake of simplicity*.
    public String myString = "Hello, world!";
    public int myInt = 123;

    // You can also use arrays, lists, & maps.
    public ArrayList<String> myList = List.of("Hello", "world!");

    // Members don't have to be public.
    private String privateString = "Private members are supported too!";

    // Annotate with @YamlIgnore to prevent a member from being read/written to the YAML file.
    @YamlIgnore
    public String ignoredString = "This string will not be read/written to the YAML file.";

    // Annotate with @YamlKey to change the key used for a member in the YAML file. Use periods (.) to nest keys.
    @YamlKey("custom_key_name")
    public String customKeyName = "This string will be read/written to the YAML file with the key custom_key_name.";

    // You can add comments to the YAML file to help document it a bit better. They'll be put above the member.
    @YamlComment("This is a comment above the member.")
    public String commentExample = "This string will be read/written to the YAML file with a comment above it.";

    // You *must* include a zero-args constructor.
    private MyConfig() {
    }
}

myString: Hello, world!
myInt: 123
myList:
  - Hello
  - world!
privateString: Private members are supported too!
custom_key_name: This string will be read/written to the YAML file with the key custom_key_name.
# This is a comment above the member.
commentExample: This string will be read/written to the YAML file with a comment above it.

@YamlFile(header = "This is a header!")
public class MyConfig {
    // ...
}

Which will add the following to the top of the file:

# This is a header!

public class AppClass {
    
    private MyConfig config;

    /**
     * Load the config file, or create a default config file using the defaults if one is not already present on disk.
     * @throws IllegalStateException if the config fails to load
     */
    public void createConfig() throws IllegalStateException {
        try {
            // Create an annotaml instance. This will read the config file from disk, or create a new one if it doesn't exist.
            final Annotaml<MyConfig> annotaml = Annotaml.create(new File("./config.yml"), new MyConfig());
            
            // Then, get the config object being wrapped by Annotaml.
            this.config = annotaml.get();
        } catch (IOException | InvocationTargetException | InstantiationException | IllegalAccessException e) {
            throw new IllegalStateException("Failed to create config", e);
        }
    }

}

public class AppClass {

    private MyConfig config;

    public void createConfig() throws IllegalStateException {
        try {
            final Annotaml<MyConfig> annotaml = Annotaml.create(new File("./config.yml"), MyConfig.class).get();
        } catch (IOException | InvocationTargetException | InstantiationException | IllegalAccessException e) {
            throw new IllegalStateException("Failed to create config", e);
        }
    }

}

public class AppClass {

    private MyConfig config;

    public void saveConfig() throws IllegalStateException {
        this.config.myString = "Save me!";
        
        try {
            // Create a *new* Annotaml wrapper over the newly modified object...
            final Annotaml<MyConfig> annotaml = Annotaml.create(config);
            
            // Call #save() on it to write the config to disk!
            annotaml.save(new File("./saved_config.yml")); // This will overwrite the file if it already exists.
        } catch (Throwable e) {
            throw new IllegalStateException("Failed to save config", e);
        }
    }

}