Skip to content

Commit

Permalink
chore(docs): update readme and remove old screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
harunbleech committed Oct 30, 2024
1 parent 8240c48 commit f5aae8c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
Binary file removed .wordpress-org/screenshot-7.png
Binary file not shown.
64 changes: 32 additions & 32 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Find issues before others do – every time. With automatic screenshots, daily c

How do you check your website after updates and code changes? Do you manually go through pages, or do you just cross your fingers, hoping everything will be okay? Visual regression testing provides a better way to spot issues and detect visual changes. The VRTs plugin automates testing for you with a click of a button.

1. **Activate Tests for any page or post:** Upon activation, a reference screenshot is taken. This will be renewed when a post is saved or updated.
2. **VRTs monitors your pages:** Every day, VRTs captures and compares screenshots of your selected pages. Upgrade to Pro to automate Tests for WordPress updates, integrate deployment pipelines via API, and run Manual Tests on demand.
2. **Receive instant alerts:** If a change is detected between the snapshot and the comparison screenshot, the plugin will notify you via email.
3. **Review changes:** The difference view makes it easy to spot changes, while the comparison slider lets you inspect the details.
4. **Hide elements:** Prevent false positives by excluding dynamic elements, ads and animations from snapshots.
1. **Activate tests for any page or post:** Upon activation, a reference screenshot is taken. This will be renewed when a post is saved or updated.
2. **VRTs monitors your pages:** Every day, VRTs captures and compares screenshots of your selected pages. Upgrade to Pro to automate tests for WordPress updates, integrate deployment pipelines via API, and run manual tests on demand.
3. **Receive instant alerts:** If a change is detected between the snapshot and the comparison screenshot, the plugin will notify you via email.
4. **Review changes:** The difference view makes it easy to spot changes, while the comparison slider lets you inspect the details.
5. **Hide elements:** Prevent false positives by excluding dynamic elements, ads, and animations from snapshots.


= Use cases =
Expand All @@ -41,38 +41,38 @@ In which cases can visual regression testing help you spot issues?

= Features =

* **No setup:** After plugin activation, the frontpage is immediately monitored and alerts are sent to the WordPress admin email.
* **No Setup:** After plugin activation, the frontpage is immediately monitored and alerts are sent to the WordPress admin email.
* **Daily Tests:** The plugin monitors selected posts and pages and compares screenshots daily.
* **Hide Elements:** Hide dynamic or irrelevant elements to prevent false positives in your Tests.
* **Hide Elements:** Hide dynamic or irrelevant elements to prevent false positives in your tests.
* **Click Element:** Define an element that should be clicked before taking a screenshot. This is useful for closing cookie banners or modals.
* **Email Notifications:** As soon as a change is detected between the snapshot and the comparison screenshot, you will be notified via email.
* **Fullscreen Review:** Inspect changes up close using the difference view and comparison slider in fullscreen mode.
* **Read / Unread:** Keep track of Test results that require further attention by marking Alerts as unread.
* **Read / Unread:** Keep track of test results that require further attention by marking alerts as unread.
* **Flag False Positives:** Identify acceptable changes or non-issues to minimize unnecessary notifications.
* **Update Automation (Pro):** Automatically trigger Tests on WordPress core , plugin, theme, or language updates and catch any issues right away.
* **Manual Testing (Pro):** Run Tests manually on demand, either for all configured pages or for specific pages, to verify any changes or global edits immediately.
* **API integration (Pro):** Trigger Tests via PHP scripts or WP CLI for integration with other tools, deployment pipelines or custom automations.
* **Update Automation (Pro):** Automatically trigger tests on WordPress core, plugin, theme, or language updates and catch any issues right away.
* **Manual Testing (Pro):** Run tests manually on demand, either for all configured pages or for specific pages, to verify any changes or global edits immediately.
* **API Integration (Pro):** Trigger tests via PHP scripts or WP CLI for integration with other tools, deployment pipelines, or custom automations.
* **Customizable Notifications (Pro):** Specify email addresses for each trigger, to set up notifications for various teams or stakeholders.


= Free forever =
* test up to **3 pages**
* on **one** domain
* **automatic daily** Tests
* Test up to **3 pages**
* On **one** domain
* **Automatic daily** tests


= Go Pro =

Do you like VRTs and want to run more Tests?
Do you like VRTs and want to run more tests?
Unlock more features with our paid plans:

* test up to **500 pages** in total
* on **multiple** domains
* **Scheduled daily** Tests
* Test up to **500 pages** in total
* On **multiple** domains
* **Scheduled daily** tests
* **Multiple** alert recipient groups by alert type
* **Manual Tests** (unlimited)
* **Manual tests** (unlimited)
* **API access** (unlimited) [Read the docs.](https://vrts.app/docs/)
* **Automatic Tests** after WordPress updates, Plugin updates and Plugin installations
* **Automatic tests** after WordPress updates, plugin updates and plugin installations

[See pricing plans](https://vrts.app/pricing/)

Expand All @@ -96,7 +96,7 @@ With visual regression testing, you can detect errors and unwanted changes on yo

= How does visual regression testing work? =

Tests can be done manually, pixel-by-pixel, DOM-based or AI-based. In all cases you compare an earlier website state with a newer website state. Our Visual Regression Tests Plugin takes periodical screenshots and compares them on a split screen.
Tests can be done manually, pixel-by-pixel, DOM-based or AI-based. In all cases, you compare an earlier website state with a newer one. Our Visual Regression Tests Plugin takes periodical screenshots and compares them on a split screen.

= Why should I use a tool for visual regression tests? =

Expand All @@ -108,7 +108,7 @@ Screenshots and comparisons are performed on an external server and sent to your

= Why are email notifications not working properly? =

If our external screenshot service can not access your WordPress installation directly, test status updates and sending emails will be handled by the WP-Cron system. In order to be notified by the plugin about new alerts, please make sure that your WordPress instance can send emails and that the WordPress cron system is set up correctly. The default configuration of the WordPress cron system does not work reliably if you cache your site heavily, do not have frequent visitors or do not use wp-admin regularly. In this case, you should [hook the WP-Cron into the system task scheduler](https://developer.wordpress.org/plugins/cron/hooking-wp-cron-into-the-system-task-scheduler/), or use an external cron job scheduling service.
If our external screenshot service cannot access your WordPress installation directly, test status updates and sending emails will be handled by the WP-Cron system. In order to be notified by the plugin about new alerts, please make sure that your WordPress instance can send emails and that the WordPress cron system is set up correctly. The default configuration of the WordPress cron system does not work reliably if you cache your site heavily, do not have frequent visitors or do not use wp-admin regularly. In this case, you should [hook the WP-Cron into the system task scheduler](https://developer.wordpress.org/plugins/cron/hooking-wp-cron-into-the-system-task-scheduler/), or use an external cron job scheduling service.

= Does the plugin work with cookie consent banners? =

Expand All @@ -120,7 +120,7 @@ The VRTs plugin primarily supports WordPress pages and posts. Automated visual t

* Create a new blank page or post in WordPress.
* Set up a redirect from this page to your desired URL.
* Configure a Test for this page. The screenshotter will follow the redirect.
* Configure a test for this page. The screenshotter will follow the redirect.

= How do I prevent screenshots from getting blocked? =

Expand All @@ -143,7 +143,7 @@ For Cloudflare, follow these steps:
(recommended)

1. Open **Plugins > Add new**
2. Search for **Visual Regression Tests**
2. Search for **vrts**
3. Click **install and activate** the plugin


Expand Down Expand Up @@ -172,20 +172,20 @@ For Cloudflare, follow these steps:
== Screenshots ==

1. Review changes using the difference view and comparison slider.
2. Get an overview of all past Test Runs, their Triggers and detected changes.
3. Manage all your registered Test pages.
4. Activate Tests right within the editor.
5. Specify multiple alert recipients for each Trigger.
6. Run unlimited Manual Tests at any time (Pro Feature).
2. Get an overview of all past test runs, their triggers and detected changes.
3. Manage all your registered test pages.
4. Activate tests right within the editor.
5. Specify multiple alert recipients for each trigger (Pro Feature).
6. Run unlimited manual tests at any time (Pro Feature).


== Changelog ==

= 2.0.0 =
* Introduced Runs
* New Test Review experience
* Automatic Tests on WordPress and plugin updates
* Customizable notification recipients for each Trigger
* New test review experience
* Automatic tests for WordPress and plugin updates
* Customizable notification recipients for each trigger

= 1.9.1 =
* Fixed alerts pagination SQL query compatibility with MySQL 5.7 and lower.
Expand Down

0 comments on commit f5aae8c

Please sign in to comment.