Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions plugins/basicrum/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Privacy-first Real User Monitoring with consent-controlled loading, page types,

Basicrum connects WordPress to a hosted or self-hosted Basicrum collector. It uses the bundled open source Boomerang library to measure how real visitors experience your site.

**Basicrum is currently in private beta.** [Contact Basicrum](https://www.basicrum.com/contact/) to request beta access and receive the Beacon URL and Brum Site ID required to configure the plugin.
**Join the free public beta of hosted Basicrum.** [Sign up for the hosted service](https://www.basicrum.com/signup) to get started with Real User Monitoring on your site.

**Prefer to self-host?** [Run the Basicrum single-server community edition](https://github.com/basicrum/basicrum-single-instance-community) on your own server. Whichever option you choose, enter its Beacon URL and Brum Site ID in the plugin.

Basicrum supports two monitoring modes:

Expand All @@ -39,7 +41,7 @@ Visit [basicrum.com](https://www.basicrum.com/) for more information about the B
1. Install and activate Basicrum.
2. Open **Basicrum** in the WordPress admin sidebar.
3. Check **Enable Basicrum** to unlock its settings.
4. Enter the Beacon URL and Brum Site ID provided with your beta access.
4. Enter your collector's Beacon URL and matching Brum Site ID.
5. Review the Visitor Consent and Consent Tool Connection settings.
6. Save Changes.

Expand All @@ -54,7 +56,7 @@ Visit [basicrum.com](https://www.basicrum.com/) for more information about the B

= What do I need to use Basicrum? =

You need a Basicrum collector endpoint and its matching Brum Site ID. During the private beta, [contact Basicrum](https://www.basicrum.com/contact/) to request access and receive both values.
You need a Basicrum collector endpoint and its matching Brum Site ID. [Join the free hosted public beta](https://www.basicrum.com/signup) or [self-host the single-server community edition](https://github.com/basicrum/basicrum-single-instance-community).

= Does Basicrum make my site compliant with privacy laws? =

Expand Down Expand Up @@ -100,7 +102,7 @@ Beacons go only to the configured endpoint. The plugin does not contact basicrum

The collector may be hosted or self-hosted. Its operator determines retention, access, deletion, hosting, and transfer arrangements, and publishes the terms and privacy notice that apply. Review them before enabling monitoring.

For the Basicrum hosted option, see the [Basicrum platform](https://www.basicrum.com/) and the [Basicrum Privacy Notice](https://www.basicrum.com/privacy/), which covers the basicrum.com website, contact messages, and beta access requests. Ask [Basicrum](https://www.basicrum.com/contact/) for the hosted collector's service terms and privacy notice before you point the plugin at a hosted collector.
For the Basicrum hosted public beta, see the [Basicrum platform](https://www.basicrum.com/), [Public Beta Terms](https://www.basicrum.com/beta-terms), and [Public Beta Privacy Notice](https://www.basicrum.com/beta-privacy) before you point the plugin at the hosted collector.

== Third-party software ==

Expand Down
7 changes: 7 additions & 0 deletions wordpress-org-assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ The canonical source artwork is
`plugins/basicrum/assets/images/basicrum-logo.png`, which the settings page
uses at runtime.

The banners combine that logo with a Chrome capture of the public Basicrum
Core Web Vitals demo and a compact page-breakdown detail based on a supplied
screenshot. The captures and `design-reference/build-banner.py` are kept under
`design-reference/` so the artwork can be revised. The builder requires Pillow
and the macOS Arial fonts. Keep the design references out of the WordPress.org
SVN assets directory; only the named banners, icons, and screenshots belong there.

This directory remains outside `plugins/basicrum/`, so the release build does
not include these WordPress.org-only files in the installable Basicrum ZIP. See
[Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
Expand Down
Binary file modified wordpress-org-assets/banner-1544x500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified wordpress-org-assets/banner-772x250.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading