=== FerimanEdge Regime Widget ===
Contributors: ferimanedge, feriman
Tags: crypto, widget, bitcoin, ethereum, bnb
Requires at least: 6.0
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.0.1
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Embed FerimanEdge's public crypto market regime widgets (BTC, ETH, BNB, All Markets) anywhere on your site via a shortcode or a Gutenberg block.

== Description ==

FerimanEdge Regime Widget displays the latest published market regime status for BTC, ETH, and BNB directly in WordPress, either individually or together. Each widget shows the current BULL, SIDEWAYS, or BEAR classification for the selected market, or for BTC, ETH, and BNB together.

Add the widget to any WordPress page or post using a shortcode or a Gutenberg block. Choose the market, visual theme, and size without editing HTML.

The plugin itself does not fetch, store, or process market data. It generates a plain `<iframe>` pointing to the selected FerimanEdge widget. The widget content is served directly by ferimanedge.com to the visitor's browser.

== Features ==

* Shortcode: `[ferimanedge_regime coin="btc" theme="visitor" size="standard"]`
* Gutenberg block with a local preview and simple dropdowns for coin, theme, and size
* Supported coins: BTC, ETH, BNB, or All Markets
* Supported themes: Dark, Light, or Follow visitor OS setting (follows the visitor's OS/browser `prefers-color-scheme` setting)
* Supported sizes: Compact, Standard, Large
* No third-party JavaScript or CSS dependencies are bundled in the plugin. The widget content is loaded from ferimanedge.com through an iframe.
* No server-side API calls and nothing to configure globally
* Invalid attribute values automatically fall back to sane defaults instead of breaking the page

== Third-party service ==

This plugin embeds content from **ferimanedge.com**, an independent, third-party crypto market-data and trading-edge service that is not affiliated with WordPress.org.

When a page containing the shortcode or the block is viewed, the visitor's browser loads an `<iframe>` directly from `https://ferimanedge.com/widget/{coin}`. As with any embedded image, video, or iframe hosted on an external domain, this means the visitor's IP address and the fact that the request was made are transmitted to ferimanedge.com's servers. The plugin itself never makes any outbound server-side request (no `wp_remote_get()`, no API calls). It only outputs the iframe's HTML.

* [Terms of Service](https://ferimanedge.com/tos)
* [Privacy Policy](https://ferimanedge.com/privacy-policy)

== Installation ==

1. Upload the `ferimanedge-regime-widget` folder to `/wp-content/plugins/`, or install it via Plugins → Add New → Upload Plugin.
2. Activate the plugin through the "Plugins" menu in WordPress.
3. Use the shortcode `[ferimanedge_regime]` in any post or page, or add the "FerimanEdge Regime Widget" block from the block inserter.

== Frequently Asked Questions ==

= Does this plugin send any of my site's data to FerimanEdge? =

No. The plugin never makes a server-side request to ferimanedge.com. It only outputs an `<iframe>` tag; the visitor's own browser loads it, the same way it would load an embedded YouTube video.

= What shortcode attributes are available? =

* `coin`: `btc`, `eth`, `bnb`, or `all` (default: `all`)
* `theme`: `dark`, `light`, or `visitor` (default: `visitor`)
* `size`: `compact`, `standard`, or `large` (default: `standard`)

Any unrecognized value silently falls back to its default instead of breaking the page.

= What does "Follow visitor OS setting" do? =

This option omits the `theme` parameter from the embed URL, so the widget follows the visitor's OS/browser `prefers-color-scheme` setting. It does not detect or read your WordPress theme.

= Does the block make extra requests while I'm editing? =

No. The block editor uses a local preview and does not load the FerimanEdge iframe while you are editing. The actual `<iframe>` is loaded when a published page containing the block is viewed.

== Screenshots ==

1. BTC regime widget in dark mode.
2. BTC regime widget in light mode.
3. ETH regime widget in dark mode.
4. ETH regime widget in light mode.
5. BNB regime widget in dark mode.
6. BNB regime widget in light mode.
7. All Markets regime widget in dark mode.
8. All Markets regime widget in light mode.

== Changelog ==

= 1.0.1 =
* Renamed the Auto theme option to Follow visitor OS setting and changed its shortcode value from `auto` to `visitor`.
* Clarified the supported market statuses and the visitor OS color-scheme behavior.
* Improved the README structure and service links.

= 1.0.0 =
* Initial release: shortcode and Gutenberg block for embedding FerimanEdge regime widgets.

== Upgrade Notice ==

= 1.0.1 =
Renames the Auto theme option to Follow visitor OS setting and clarifies its behavior.

= 1.0.0 =
Initial release.
