From 537c936ab32baef563a37dac236e03ab7d5a6431 Mon Sep 17 00:00:00 2001 From: Martien Date: Mon, 16 Jun 2025 10:14:10 +0200 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efd3ef2..03a9f6a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ -# wp-mempool-info +# Mempool Info WordPress Plugin + +**Show the current Bitcoin block height and transaction fee estimates in your WordPress site, using a configurable mempool.space API endpoint.** + +--- + +## Features + +- Displays the current Bitcoin block height. +- Shows transaction fee estimates (sat/vB) for fastest, half hour, and hour confirmations. +- Works with public mempool.space or your own self-hosted instance. +- Easy setup via the WordPress admin interface. +- Simple shortcodes for use anywhere on your site. + +--- + +## Installation + +1. Upload the plugin folder to your WordPress `/wp-content/plugins/` directory, or use the plugin uploader. +2. Activate the plugin from the WordPress dashboard. +3. Go to **Settings → Mempool Info** to configure your preferred mempool API URL (default is `https://mempool.space/api`). + +--- + +## Usage + +Add these shortcodes to any page, post, or widget: + +- **Current Bitcoin block height:** + `[mempool_block_height]` + +- **Transaction fee estimates:** + `[mempool_fees]` + +--- + +## Example -An wordpress plugin to show information from (a self-hosted) mempool.space \ No newline at end of file