Update README.md

This commit is contained in:
2025-06-16 10:14:10 +02:00
parent 388e5f8b16
commit 537c936ab3

View File

@ -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