=== MarkerKit ===
Contributors: markerkit
Tags: interactive image, clickable image map, openstreetmap, floor plan, hotspot
Requires at least: 6.0
Tested up to: 6.8
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

A lightweight plugin to embed interactive images and maps from MarkerKit using a shortcode or Gutenberg block.

== Description ==

MarkerKit turns static images, floor plans, diagrams, and maps into interactive embeds you can add to any page with a shortcode or Gutenberg block. Use the visual editor to place hotspots and polygons, attach popups, enable menu/search, and switch between multiple views (e.g., floors or layouts). 

Supports **OpenStreetMap** tiles, zoom and fullscreen, and built-in analytics. Optionally bind to your JSON endpoints so objects, statuses, and labels stay up to date. Developer APIs (REST + JS) are available for automation and advanced integrations.

**This WordPress plugin connects to the MarkerKit platform, which offers a free tier with all features included, ideal for small websites and prototypes.**

### What can you do with MarkerKit?

**Real Estate**
- Highlight buildings on an OpenStreet map
- Highlight floors and units
- Switch between floor plans or maps
- Add popups with descriptions and links
- Show property availability or pricing
- Integrate with booking or CRM tools

**Education**
- Annotate diagrams, maps, or illustrations
- Create interactive lessons and explanations
- Use popups for added context
- Label anatomy or technical drawings
- Add quizzes or learning checkpoints
- Embed in LMS or classroom websites

**Enterprise**
- Campus maps
- Factory or office layouts
- Technical schematics and workflows
- Equipment or asset tracking
- Safety or evacuation maps
- Live dashboards

### Core Features

- **Interactive Images and Maps** — add hotspots, shapes, and tooltips to any image or floor plan.
- **OpenStreetMap Support** — use real map tiles as a background or combine them with custom imagery.
- **Multiple Views** — switch between floors, blueprints, or visual modes.
- **Popups and Tooltips** — show detailed information when users hover or click.
- **Live Data Binding** — connect objects to JSON or API data to automatically create or update objects.
- **Analytics** — track user interactions to see which areas get the most attention.
- **APIs for Developers** — for automation and advanced integrations.

**Privacy**

This plugin loads an external script from `https://edge.markerkit.com` to render your project.  
No user data is collected by the plugin itself.

== Installation ==

1. Upload the `markerkit` folder to the `/wp-content/plugins/` directory, or install via the WordPress Plugins screen.
2. Activate the plugin through the ‘Plugins’ screen in WordPress.
3. Add `[markerkit id="YOUR_PROJECT_ID"]` to any post or page, **or** use the “MarkerKit” block in the Gutenberg editor.

== Frequently Asked Questions ==

= Is MarkerKit free? =
Yes. MarkerKit has a generous free tier that includes all features.
The included usage is more than enough for a small website or prototype.

= What can I build with MarkerKit? =
You can make any image, floor plan, or map interactive — highlight areas, add popups, link between floors, and embed it on your website.  
Typical uses include real estate floor plans, campus maps, product diagrams, and interactive lessons.

= Can I connect it to live data? =
Yes. MarkerKit supports data binding — fetch JSON from your endpoints and update markers automatically at load.  
This is ideal for reflecting statuses, prices, or availability in real time.

= How do I get support? =
All users — including Free — get email support for setup and configuration. 

= Does this plugin collect data? =
No. The plugin itself does not collect or send any data.  
The embedded MarkerKit project may connect to `edge.markerkit.com` to load content and scripts necessary for rendering.

= Can I disable the external script? =
If you remove the shortcode or block, no script is loaded.

= Does this plugin require a MarkerKit account? =
Yes, you need a MarkerKit project ID from your MarkerKit dashboard.

= Can I use multiple MarkerKit projects on one site? =
Yes. You can embed different project IDs on different pages, or even multiple MarkerKit projects on the same page.  
Each instance loads its own MarkerKit client script.

= Will the plugin work with page builders? =
Yes. The shortcode can be added inside most page builders such as Elementor, Divi, and WPBakery.  
Alternatively, use the Gutenberg block if you’re using the WordPress block editor.

= Does the plugin work with caching or optimization plugins? =
Yes. MarkerKit loads asynchronously through a single external script, which is compatible with most caching and optimization setups.  
If your site uses aggressive JavaScript optimization, you may need to exclude the MarkerKit script from minification.

= What happens if the MarkerKit script can’t load? =
If the external script is blocked or unavailable, the page will simply show the placeholder container where the project would appear — no errors or layout issues occur.


== Links ==
* [Website](https://markerkit.com?utm_source=wordpress&utm_medium=plugin)
* [Developer Documentation](https://markerkit.com/developers?utm_source=wordpress&utm_medium=plugin)
* [Privacy Policy](https://markerkit.com/privacy)

== Changelog ==

= 1.0.0 =
* Initial release