From bc1877e81fb7853e7f6aba18f6d69b58070c9669 Mon Sep 17 00:00:00 2001 From: Glynn Quelch Date: Sun, 26 Apr 2026 23:38:38 +0100 Subject: [PATCH 1/2] docs: add Packagist, GitHub, CI, and Codecov badges to README Matches the badge convention used across the Perique sibling packages (Enqueue, Nonce, etc.): - Packagist: latest stable, total downloads, license, PHP version requirement - GitHub: contributors, open issues - CI: one badge per WP version workflow (6.6, 6.7, 6.8, 6.9) - Codecov: coverage badge using the repo-specific MOUNT_CODECOV upload token Heading also updated from "# PinkCrab ElmMount" to the trailing-hash style "# PinkCrab ElmMount #" used by the rest of the family. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f0631d..cf0d233 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -# PinkCrab ElmMount +# PinkCrab ElmMount # + +[![Latest Stable Version](https://poser.pugx.org/pinkcrab/elm-mount/v)](https://packagist.org/packages/pinkcrab/elm-mount) +[![Total Downloads](https://poser.pugx.org/pinkcrab/elm-mount/downloads)](https://packagist.org/packages/pinkcrab/elm-mount) +[![License](https://poser.pugx.org/pinkcrab/elm-mount/license)](https://packagist.org/packages/pinkcrab/elm-mount) +[![PHP Version Require](https://poser.pugx.org/pinkcrab/elm-mount/require/php)](https://packagist.org/packages/pinkcrab/elm-mount) +![GitHub contributors](https://img.shields.io/github/contributors/Pink-Crab/elm-mount?label=Contributors) +![GitHub issues](https://img.shields.io/github/issues-raw/Pink-Crab/elm-mount) + +[![WP 6.6 [PHP8.0-8.4] Tests](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_6.yaml/badge.svg)](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_6.yaml) +[![WP 6.7 [PHP8.0-8.4] Tests](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_7.yaml/badge.svg)](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_7.yaml) +[![WP 6.8 [PHP8.0-8.4] Tests](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_8.yaml/badge.svg)](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_8.yaml) +[![WP 6.9 [PHP8.0-8.4] Tests](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_9.yaml/badge.svg)](https://github.com/Pink-Crab/elm-mount/actions/workflows/WP_6_9.yaml) + +[![codecov](https://codecov.io/gh/Pink-Crab/elm-mount/graph/badge.svg?token=cWP0sQqG4G)](https://codecov.io/gh/Pink-Crab/elm-mount) Mount compiled Elm apps into WordPress admin pages, shortcodes and other surfaces. Handles the enqueue, the localized flags blob, and the REST nonce. Bundling your Elm is your job — this package takes the compiled `.js` and wires it into WordPress. From c619952c6b225d6414c96f564780f14e3a2c3cd0 Mon Sep 17 00:00:00 2001 From: Glynn Quelch Date: Sun, 26 Apr 2026 23:39:32 +0100 Subject: [PATCH 2/2] docs: rephrase Usage opener to describe what Elm_App does MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The previous line led with what the package does NOT do (wrap add_submenu_page / add_shortcode / add_meta_box) — meaningless context for any reader who never expected it to. New copy describes the actual usage shape positively: build the app once, call render() or parse() from any WordPress callback that produces output, with concrete examples (admin page, shortcode, meta box, widget, REST, template part). --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cf0d233..2e9102e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ composer require pinkcrab/elm-mount ## Usage -Build an `Elm_App` once with your script + flags, then either `render()` (echoes) or `parse()` (returns a string) from wherever WordPress asks you for output. This package does not wrap `add_submenu_page` / `add_shortcode` / `add_meta_box` — use WordPress's own APIs. +Build an `Elm_App` once with your script + flags, then call `render()` (echoes) or `parse()` (returns a string) from any WordPress callback that produces output — admin page, shortcode, meta box, widget, REST handler, template part. The same `$app` works for all of them. ```php use PinkCrab\ElmMount\Elm_App;