Repository navigation
docs: point readers at the v1.1.0 release - #29
Merged
Merged
Conversation
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().
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The README only documented building the JAR from source. That path needs a GitHub PAT with
read:packages, because Gradle resolvesmirror-apifrom GitHub Packages — a real barrier for someone who just wants to see the example module running on their mirror.Every
v*tag already publishes the built JAR as a GitHub Release, and downloading a release asset needs no token at all. Nothing in the README said so, so the easiest path was undocumented.Change
Adds a Releases section ahead of Build:
mirror-api1.3.0, i.e. Speculum v1.3.0 or newer, because that is wheresettingsSchema()was added.README only — no code, no build files.
Verification
Both links return 200, and the in-page
#module-settingsanchor resolves to the heading atREADME.md:95.