Files
wp-mempool-info/README.md
2025-06-16 10:21:39 +02:00

61 lines
1.4 KiB
Markdown

# 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
<h3>Latest Bitcoin Block</h3>
[mempool_block_height]
<h3>Current Transaction Fees</h3>
[mempool_fees]
---
## Configuration
To use your own mempool.space instance, set the API URL in the plugin settings page.
Example: https://your-own-mempool-instance.com/api
---
## Changelog
v0.2
Added support for custom API endpoint via settings page.
Separate shortcodes for block height and transaction fees.
License