From 9476de5e63a6de5892779de293fed49f82555d60 Mon Sep 17 00:00:00 2001 From: Pierre Jochem Date: Sun, 4 Oct 2026 13:50:29 +0200 Subject: [PATCH] docs: point readers at the v1.1.0 release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The README only described building the JAR from source, which needs a GitHub PAT with read:packages so Gradle can resolve mirror-api from GitHub Packages. Every `v*` tag already publishes the built JAR as a GitHub Release, and downloading a release asset needs no token at all — but nothing said so, so the easiest path to a running module was undocumented. Adds a Releases section ahead of Build, naming v1.1.0 as current, linking the release and the releases index, and recording that it needs mirror-api 1.3.0 (Speculum v1.3.0 or newer) because of settingsSchema(). --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 084b0e9..1422ca4 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,19 @@ export GITHUB_ACTOR= export GITHUB_TOKEN= ``` +## Releases + +Every `v*` tag publishes the built JAR as a +[GitHub Release](https://github.com/pierrejochem/SpeculumExampleModule/releases). +The current release is +**[v1.1.0](https://github.com/pierrejochem/SpeculumExampleModule/releases/tag/v1.1.0)**, +which adds [`settingsSchema()`](#module-settings) and needs `mirror-api` 1.3.0 +(Speculum v1.3.0 or newer). + +Grabbing `SpeculumExampleModule.jar` from there and dropping it in a Speculum +install's `plugins/` folder is enough to run it — no token and no build needed, +since downloading a release asset does not go through GitHub Packages. + ## Build ```bash