WP Manifestindependent plugin directory
manifest / content / read-progress-button

Read Progress Button

Round read progress button for WordPress posts. All rights reserved.

by Stijn Vogels · github.com/stijn/read-progress-button

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/stijn/read-progress-button/archive/refs/heads/main.zip
Updates itself. It ships its own updater, so new versions appear under Dashboard → Updates.
Readme github.com/stijn/read-progress-button ↗

A round button on posts that fills as you read and leads back to the homepage. At the end of the post it grows for a moment and turns olive green, with a green glow and a check mark. Plans and past releases: roadmap.md; full detail: CHANGELOG.md.

Copyright (c) 2026 Stijn Vogels. All rights reserved. See LICENSE. The repo is public so sites can update without a token; that gives no right to use, copy or change the code.

What it does

  • On single posts, a 44 px button appears once you scroll down 50 px and stays on screen while you scroll. Its blue ring shows how much of .entry-content has come into view; the cross inside links to the homepage.
  • Settings > Read Progress Button: the corner it sits in, 0.75rem from both edges. Saving empties WP Super Cache when it's there.
  • Matches Deluminator's switch: same size, distance from the edges, frosted disc, shadow and focus ring, light and dark. In the top right it sits just under it.
  • One small stylesheet and one deferred script, on single posts only. No jQuery, no external requests.
  • Follows Deluminator's dark mode and prefers-reduced-motion.

Updates

  • The plugin updates itself from the latest release of this public repo (asset read-progress-button.zip), through plugin-update-checker. WordPress auto-updates are on for this plugin only. No token needed.
  • Optional: a fine-grained GitHub token raises GitHub's limit of 60 requests an hour per server, which every site on a shared host's IP address shares. Repository stijn/read-progress-button only, permission Contents: Read-only. Put it in wp-config.php as define( 'READ_PROGRESS_BUTTON_GITHUB_TOKEN', '...' ); or paste it on Settings > Read Progress Button. It's never shown again, logged or returned.
  • Abilities read-progress-button/plugin-status and read-progress-button/self-update report and install updates through an MCP connector.

One-time install on a site

  1. Download read-progress-button.zip from the latest release on GitHub.
  2. Plugins > Add New Plugin > Upload Plugin, choose the zip, and replace the installed version if WordPress asks. Activate. From then on it updates itself.

Release steps

  1. Change code; bump Version: and READ_PROGRESS_BUTTON_VERSION in read-progress-button.php; add a ## x.y.z section to CHANGELOG.md and a dated ## x.y.z (date) section to roadmap.md (move finished items out of "Next").
  2. Commit, push to main; the Test workflow runs WordPress on PHP 7.4, 8.3 and 8.5.
  3. Tag vx.y.z and push the tag. The Release workflow checks the version matches the tag, lints, builds the zip and creates the release.
  4. Sites pick it up within 6 hours through WordPress's auto-updates, or right away through the self-update ability.
  5. Run the Test workflow by hand (Actions > Test > Run workflow) to check the whole update cycle: an older copy without a token updates itself to the latest release through wp_maybe_auto_update().

Credits