docs: improve documentation for brew releasing

Author: simschla

README.md

@@ -34,7 +34,7 @@ Example usage:
 ```shell
 spotless --target '**/src/**/*.java' \
     google-java-format \
-    license-header --header='/* (c) Diffplug $YEAR */'
+    license-header --header='/* (c) DiffPlug $YEAR */'
 ```
 
 This command formats all java files in any `src` folder with the [google-java-format](https://github.com/google/google-java-format) and adds (or updates an existing) license header.
@@ -45,13 +45,13 @@ Using the above command line you go
 output = [
   '| From this | to this |',
     '| --- | --- |',
-  '| ' + image('before', 'docs/examples/intro/resized/FormattingExample.java.png') + ' | ' + image('after', 'docs/examples/intro/resized/FormattingExampleFormatted.java.png') + ' |',
+  '| ' + image('before', 'docs/examples/intro/FormattingExample.png') + ' | ' + image('after', 'docs/examples/intro/FormattingExampleFormatted.png') + ' |',
   ].join('\n')
 -->
 
-| From this                                                         | to this                                                                   |
-| ----------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| ![before](docs/examples/intro/resized/FormattingExample.java.png) | ![after](docs/examples/intro/resized/FormattingExampleFormatted.java.png) |
+| From this                                            | to this                                                      |
+| ---------------------------------------------------- | ------------------------------------------------------------ |
+| ![before](docs/examples/intro/FormattingExample.png) | ![after](docs/examples/intro/FormattingExampleFormatted.png) |
 
 <!---freshmark /example_usage_before_after -->
 
@@ -60,7 +60,11 @@ output = [
 To install with Homebrew on macOS or Linux:
 
 ```shell
-brew install ...
+brew install diffplug/tap/spotless-cli
+
+# or if you prefer
+brew tap diffplug/tap
+brew install spotless-cli
 ```
 
 To install with Chocolatey on Windows:
@@ -250,7 +254,7 @@ Runs license header
 Example usage:
 
 ```shell
-spotless --target '**/src/**/*.java' license-header --header='/* (c) Diffplug $YEAR */'
+spotless --target '**/src/**/*.java' license-header --header='/* (c) DiffPlug $YEAR */'
 ```
 
 ### prettier

app/src/jreleaser/distributions/spotless-cli/brew/README.md.tpl

@@ -14,35 +14,5 @@ $ brew tap {{brewRepositoryOwner}}/{{brewRepositoryAlias}}
 $ brew install <formula>
 ```
 
-Invoke the following command if the formula is *not* hosted at GitHub
-
-```sh
-brew tap {{brewRepositoryOwner}}/{{brewRepositoryName}} {{tapRepoCloneUrl}}
-brew install <formula>
-```
-
-## Casks
-Invoke either of the following commands if the cask is hosted at GitHub
-
-```sh
-$ brew install --cask {{brewRepositoryOwner}}/{{brewRepositoryAlias}}/<cask>
-```
-
-Or
-
-```sh
-$ brew tap {{brewRepositoryOwner}}/{{brewRepositoryAlias}}
-$ brew install --cask <cask>
-```
-
-Invoke the following command if the cask is *not* hosted at GitHub
-
-```sh
-brew tap {{brewRepositoryOwner}}/{{brewRepositoryName}} {{tapRepoCloneUrl}}
-brew install --cask <formula>
-```
-
-If you get a dialog stating the cask is broken try installing with `--no-quarantine`.
-
 ## Documentation
 `brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).

build-logic/src/main/groovy/buildlogic.spotless-yaml-conventions.gradle

@@ -4,7 +4,7 @@ plugins {
 
 spotless {
 	yaml {
-		target '.github/workflows/*.yml'
+		target '.github/workflows/*.yml', '*.yml'
 		prettier()
 	}
 }

docs/examples/intro/FormattingExample.png

@@ -1,4 +1,4 @@
-/* (c) Diffplug 2025 */
+/* (c) DiffPlug 2025 */
 public class FormattingExample {
   public static void main(String[] args) {
     int x = 10;

docs/examples/intro/FormattingExampleFormatted.java

@@ -0,0 +1,26 @@
+# Creating images from example code for README.md
+
+1. Navigate to [carbon.now.sh](https://carbon.now.sh/).
+2. Import the settings:
+   - Click on the gear icon in the top right corner.
+   - Click on "Misc".
+   - Click on the "Import" button.
+   - Select the file `carbon_settings.json` from the `docs/examples/intro` directory.
+
+## Creating an image for the `FormattingExample` class
+1. Copy and paste the code from the `FormattingExample.java` file in the `docs/examples/intro` directory.
+2. Select all the text and click on the "B" button in the top right corner (for bold font).
+3. Click on the Down-Arrow of the "Export" button in the top right corner.
+4. Click on "1x".
+5. Edit the filename to `FormattingExample`.
+6. Click on "Download -> PNG".
+7. Move the downloaded image to the `docs/examples/intro` directory.
+
+## Creating an image for the `FormattingExampleFormatted` class
+1. Copy and paste the code from the `FormattingExampleFormatted.java` file in the `docs/examples/intro` directory.
+2. Select all the text and click on the "B" button in the top right corner (for bold font).
+3. Click on the Down-Arrow of the "Export" button in the top right corner.
+4. Make sure "1x" is selected.
+5. Edit the filename to `FormattingExampleFormatted`.
+6. Click on "Download -> PNG".
+7. Move the downloaded image to the `docs/examples/intro` directory.

docs/examples/intro/FormattingExampleFormatted.png

@@ -0,0 +1 @@
+{"paddingVertical":"41px","paddingHorizontal":"54px","backgroundImage":null,"backgroundImageSelection":null,"backgroundMode":"color","backgroundColor":"rgba(171,184,195,0)","dropShadow":true,"dropShadowOffsetY":"20px","dropShadowBlurRadius":"68px","theme":"shades-of-purple","windowTheme":"none","language":"text/x-java","fontFamily":"Fira Code","fontSize":"18px","lineHeight":"133%","windowControls":true,"widthAdjustment":true,"lineNumbers":false,"firstLineNumber":1,"exportSize":"1x","watermark":false,"squaredImage":false,"hiddenCharacters":false,"name":"","width":680,"highlights":null}