=== PinMarks – Visual Website Feedback ===
Contributors: pinmarks
Tags: feedback, bug report, visual feedback, annotations, website feedback
Requires at least: 5.8
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 0.1.2
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Collect visual bug reports and annotated feedback straight from your WordPress site. No code required.

== Description ==

[PinMarks](https://pinmarks.in/) is a visual feedback tool for agencies, freelancers and product teams. Your clients and colleagues point at what is wrong on your WordPress site, and you get an annotated screenshot with the technical details a developer needs, without the back-and-forth of emails, spreadsheets and screenshots in chat.

**Set up in a minute:** install, click "Connect with PinMarks" (or paste your project key), done.

= How it works =

1. A feedback button appears on your site.
2. Reporters click it, annotate a screenshot and write a short note. No account or install needed on their side.
3. The report lands in your PinMarks project with the page URL, browser, screen size and more, ready to be sent to the tools you already use.

= Best features =

* **On-site reporting** – clients and colleagues report straight on the page they are looking at.
* **Annotated screenshots** – pins, drawings, highlights and text on top of a screenshot of the page.
* **Technical details attached** – page URL, browser, device, screen size and, when enabled, console and network errors.
* **Integrations** – send issues to Jira, GitHub, GitLab, Linear, Asana, ClickUp, Trello, Monday.com, Notion, Slack, Basecamp, Shortcut, Teamwork, Wrike and Azure DevOps.
* **Comments** – discuss each issue with the reporter without leaving your workflow.
* **Widget customization** – adjust the look of the button and the form to fit your brand.
* **Responsive** – works on desktop and mobile browsers.

= Built for WordPress =

* **No-code installation** – no snippet to paste into your theme.
* **Connect popup** – pick or create a PinMarks project without copying keys.
* **Smart visibility** – show the button to everyone, logged-in users or specific roles; limit it by post type, post status or URL (with wildcards); or show it only on staging sites.
* **Logged-in users identified** – no name and email fields for people who are signed in to WordPress.
* **WordPress details with every report** – WordPress and PHP version, theme, active plugins, page builder, a direct edit link and WooCommerce cart context (requires custom metadata to be enabled on your PinMarks project).
* **Admin bar menu** – report an issue or switch the widget on and off from the toolbar.
* **Shortcode and block** – `[pinmarks_button label="Report an issue"]` or the "PinMarks report button" block.

A free or paid PinMarks account is required. Sign up at [pinmarks.in](https://pinmarks.in/).

== External services ==

This plugin connects to the PinMarks service (app.pinmarks.in), to provide the feedback widget.

**What it is and what it is used for:** on the pages where the widget is shown, the plugin loads the widget script from `https://app.pinmarks.in/widget.js`. The widget lets people submit feedback, and sends it to your PinMarks project.

**What data is sent and when:**

* When a page that shows the widget loads, the visitor's browser requests the widget script and the widget settings for your project key from app.pinmarks.in. This includes the visitor's IP address and browser details, as with any web request.
* Only when a person chooses to submit feedback: their message, an annotated screenshot, the page address, browser and device details, console and network error logs (if enabled in your PinMarks project), and any name and email they enter.
* If "Identify logged-in users automatically" is enabled (default), the WordPress display name and email of the logged-in user are passed to the widget and sent along with their feedback.
* If "Send WordPress environment details with reports" is enabled (default), WordPress and PHP version, theme, active plugins, page details and, for WooCommerce sites, cart contents are attached to submitted feedback.
* When you use "Connect with PinMarks" in the settings page, your browser opens a popup on app.pinmarks.in where you sign in and choose a project; the project key is passed back to your settings page. Your site address is sent so the key is only delivered to your site.

Nothing is sent to PinMarks until a project key is saved and the widget is enabled.

This service is provided by PinMarks: [Privacy Policy](https://pinmarks.in/privacy).

== Installation ==

1. Upload the plugin and activate it.
2. Go to Settings > PinMarks and click "Connect with PinMarks", or paste your project key.
3. Visit your site; the feedback button appears.

== Frequently Asked Questions ==

= What is PinMarks? =

A visual feedback and bug reporting tool. People report issues directly on your website with an annotated screenshot, and the report arrives in your PinMarks project with technical details attached.

= Do I need a PinMarks account to use the plugin? =

Yes. The plugin only adds the feedback button to WordPress; reports are stored in your PinMarks project. Sign up at [pinmarks.in](https://pinmarks.in/).

= Where do I find my project key? =

In your PinMarks project settings. Or just use "Connect with PinMarks" and it is filled in for you.

= The button does not show on my site. =

Check that the plugin is connected and enabled, and that your visibility settings (users, post types, URL rules, staging only) allow the current page. If you use a caching or optimization plugin, exclude `app.pinmarks.in/widget.js` from minification, combining and delay.

= Does it work on local and staging sites? =

Yes. You can even limit the button to staging sites only in the plugin settings.

= Can I choose who sees the feedback button? =

Yes. Show it to everyone, to logged-in users, or to specific roles, and limit it by post type, post status or URL.

= Will the widget slow down my site? =

The widget script is loaded from app.pinmarks.in only on pages where the button is shown, and it loads asynchronously.

= Can I show the button only after cookie consent? =

Yes. Return `false` from the `pinmarks_should_load` filter until consent is given.

= Does it work with WooCommerce? =

Yes. For WooCommerce sites, cart contents can be attached to reports (requires custom metadata to be enabled on your PinMarks project).

= Are WordPress details stored in my PinMarks project? =

They are stored when custom metadata is enabled for your PinMarks project (Agency plan).

= I found a bug. How can I contact support? =

Open a thread in the plugin's support forum on WordPress.org or contact us through [pinmarks.in](https://pinmarks.in/).

== Changelog ==

= 0.1.2 =
* Expanded description and FAQ.

= 0.1.1 =
* Readme and plugin header updates.

= 0.1.0 =
* Initial release.
