Draft: Proposed changes to the README

What is refreshVersions?

refreshVersions helps Gradle users with the tedious manual work usually involved in adding and updating dependencies and their versions.

What is refreshVersions? (PROPOSED)

• TODO: replace the a bit obsolete video with the mind blowing https://asciinema.org/ which is a video where you can copy/paste the command-line used in the video.
• TODO: see dependency notations paragraph at the end

Documentation (CURRENT)

• Start here
• Setup refreshVersions
• Migrate your project
• Find Available Dependencies Updates
• Add Dependencies
• Explore Dependencies Notations
• Schedule the RefreshVersionsBot
• Use the buildSrc
• Changelog

See documentation at https://jmfayard.github.io/refreshVersions

Documentation (PROPOSED)

+ - [# RefreshVersions ♥️ Gradle Version Catalog](TK)
+ - [Troubleshooting](https://github.com/jmfayard/refreshVersions/wiki/Troubleshooting)
+ 

Depends on: those things being more mature

Setup (CURRENT)

// settings.gradle(.kts)
plugins {
    // See https://jmfayard.github.io/refreshVersions
    id("de.fayard.refreshVersions") version "0.50.1"
}

refreshVersions { // Optional: configure the plugin
    // ...
}

Read the friendly documentation

Setup (PROPOSED)

no changes proposed yet

Usage (CURRENT)

Make sure the project is correctly set up (see just above).

Migrate project:

The refreshVersionsMigrate task can help you migrate your project in a few minutes, or less.

In version 0.50.0, support for Gradle's Versions Catalogs was added (see discussion thread here), so a --mode option is now required.

Run it without it to see the complete list and the full description of each mode:

./gradlew refreshVersionsMigrate

Examples (click to expand)

If you want to use only versions.properties and the built-in dependencies notations, run:

./gradlew refreshVersionsMigrate --mode=VersionsPropertiesOnly

To also use a versions catalog for non-built-in dependency notations, run:

./gradlew refreshVersionsMigrate --mode=VersionCatalogAndVersionProperties

Find available updates in versions.properties and the default versions catalog, if any:

./gradlew refreshVersions

Cleanup versions availability comments:

./gradlew refreshVersionsCleanup

Usage (PROPOSED)

no changes proposed yet

Dependency notations (CURRENT)

IMHO we have nothing good enough yet

Dependency notations (PROPOSED)

• TK: Create cool GIF
• TK: Add link https://jmfayard.github.io/refreshVersions/dependencies-notations/