diff --git a/.github/scripts/publish-hub.sh b/.github/scripts/publish-hub.sh index b63ee2f7..a5cfaa6b 100755 --- a/.github/scripts/publish-hub.sh +++ b/.github/scripts/publish-hub.sh @@ -2,14 +2,19 @@ # Maintain the Plugin Hub publish branch for this repository. # # The Plugin Hub pins a literal commit of this repo and its reviewers diff the -# previous pin against the new one. Development history (tests, README, images, -# docs, CI) makes those reviews noisy, so this script maintains a branch that -# contains only what the Plugin Hub packager consumes for a build=standard -# plugin: +# previous pin against the new one. Development history (tests, images, docs, +# CI) makes those reviews noisy, so this script maintains a branch that +# contains only what the Plugin Hub consumes for a build=standard plugin: # # src/main/java src/main/resources lombok.config # runelite-plugin.properties icon.png LICENSE # +# plus README.md, which the Hub build itself ignores but runelite.net renders +# as the plugin description: the site fetches +# repos///readme?ref= from the GitHub API, so a pin +# without a README shows no description on +# https://runelite.net/plugin-hub/show/flipping-utilities. +# # See STANDARD_BUILD_PATHS and Plugin#build in runelite/plugin-hub-tooling; # everything else in this repository is ignored by the Hub build. # @@ -53,7 +58,8 @@ remote="${HUB_REMOTE:-origin}" plugin_slug="${PLUGIN_SLUG:-flipping-utilities}" pointer_url="https://raw.githubusercontent.com/runelite/plugin-hub/master/plugins/${plugin_slug}" -# Exactly the inputs the Plugin Hub packager reads for build=standard plugins. +# The inputs the Plugin Hub packager reads for build=standard plugins, plus +# README.md for the website description (see the header comment). keep_paths=( src/main/java src/main/resources @@ -61,6 +67,7 @@ keep_paths=( icon.png LICENSE lombok.config + README.md ) resolve() { git rev-parse --verify --quiet "$1^{commit}" || true; } diff --git a/.github/workflows/publish-hub.yml b/.github/workflows/publish-hub.yml index 4356435b..cae48f46 100644 --- a/.github/workflows/publish-hub.yml +++ b/.github/workflows/publish-hub.yml @@ -117,5 +117,6 @@ jobs: echo '```' echo "repository=https://github.com/${REPOSITORY}.git" echo "commit=${COMMIT}" + echo 'authors=AntonyGarand' echo '```' } >>"$GITHUB_STEP_SUMMARY" diff --git a/README.md b/README.md index 49e5ed2a..45c29cc2 100644 --- a/README.md +++ b/README.md @@ -33,35 +33,35 @@ The plugin is divided into three tabs: the slots tab, flipping tab and statistic This tab displays info most relevant to you when actively flipping

- +

The item cards are highly customizable, allowing you to pick what information to show in which section.

- +

### The Statistics Tab This tab records your trading history, down to every single individual offer you made.

- +

The item cards can be expanded

- +

The trade history for each item can be expanded to see the offers:

- +

And the flips:

- +

@@ -75,19 +75,19 @@ Go to your offers for an item in the stats tab. If there is a recipe for that it be present on the offer card. Click it and select the appropriate recipe

- +

adjust the inputs and outputs if necessary, then combine

- +

view your recipe flips in the "recipes" tab of the stats tab

- +

## Additional Features @@ -98,7 +98,7 @@ Slot timers help you figure out when you should cancel an offer. They show you h since the offer was last active.

- +

#### Offer editors @@ -106,7 +106,7 @@ since the offer was last active. The price and quantity help you set up your offers quickly!

- +

@@ -115,7 +115,7 @@ The price and quantity help you set up your offers quickly! Flip on mobile and have untracked trades? Just pop open your ge history and easily add untracked trades

- +

#### Favorites lookup @@ -123,7 +123,7 @@ Flip on mobile and have untracked trades? Just pop open your ge history and easi Quickly lookup your favorited items just by typing "1" in the ge search!

- +

# Development @@ -181,9 +181,13 @@ maintainer approval. After merging a release, publish a pin as described below. The Hub pins a commit of this repository and reviewers diff the previous pin against the new one. To keep those reviews limited to the plugin itself, pins live on the `hub/publish` branch, which contains only the files the Hub -packager builds: `src/main/java`, `src/main/resources`, -`runelite-plugin.properties`, `icon.png` and `LICENSE`. Everything else -(tests, README, images, docs, CI) stays on `master` only. +consumes: `src/main/java`, `src/main/resources`, +`runelite-plugin.properties`, `icon.png`, `LICENSE` and `README.md`. The Hub +build ignores the README, but runelite.net fetches it from the pinned commit +to render the description on +https://runelite.net/plugin-hub/show/flipping-utilities, so a pin without it +shows no description. Everything else (tests, images, docs, CI) stays on +`master` only. To cut a new pin: