-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
90 lines (64 loc) · 4.87 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
=== PageFlash - Fast and Efficient Headless Browser WordPress Plugin ===
Contributors: theaminuldev
Tags: headless browser, quicklink, performance, speed, speculation rules
Requires at least: 6.0
Tested up to: 6.5.5
Stable tag: 1.1.0
License: GPL-3.0
License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
Copyright: © 2023 theaminul.com
By using PageFlash, an active plugin, you'll experience a 50% increase in conversions and enjoy 4x faster page loading. ⚡️ Boost your website's speed, increase user engagement 💬, and supercharge your online presence 🚀. - NewEgg
== Description ==
PageFlash is a powerful headless browser WordPress plugin designed to provide you with a fast and efficient web browsing experience within your WordPress site. Say goodbye to page reloads and enjoy seamless navigation through web content with this plugin. Harness the speed and agility of PageFlash for your WordPress website.
### Key Features:
- **Lightning-Fast Browsing:** PageFlash lives up to its name, offering rapid page loading and navigation without the need for tedious page refreshes.
- **Smooth Script Execution:** Execute scripts and interact with web pages in a fluid and continuous manner. With PageFlash, you'll experience uninterrupted script execution, ensuring your web applications run seamlessly.
- **Prefetches:** PageFlash incorporates advanced prefetching technology to speed up your web browsing. It anticipates and loads pages in the background, reducing loading times and providing a smoother browsing experience.
- **No More Reloads:** Say goodbye to unnecessary page reloads with PageFlash, and enjoy uninterrupted web exploration. PageFlash ensures a frustration-free web experience by eliminating the need for page reloads, providing you with a streamlined and seamless browsing experience.
For more information and documentation, visit our [plugin documentation](https://theaminul.com/pageflash/docs).
### How it works:
- **Detects links within the viewport** (using [Intersection Observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API))
- **Waits until the browser is idle** (using [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback))
- **Checks if the user isn't on a slow connection** (using `navigator.connection.effectiveType`) or has data-saver enabled (using `navigator.connection.saveData`)
- **Prefetches URLs to the links** (using [`<link rel=prefetch>`](https://www.w3.org/TR/resource-hints/#prefetch) or XHR). Provides some control over the request priority (can switch to `fetch()` if supported).
If you are a developer, we encourage you to follow along or [contribute](https://github.com/theaminuldev/pageflash) to the development of this plugin [on GitHub](https://github.com/theaminuldev/pageflash).
### Browser support:
This plugin also works perfectly on popular browsers.
- 🖥 Microsoft EDGE
- 🖥 Firefox 4+
- 🖥 Chrome
- 🖥 Opera
- 📱 Android 4+
== Installation ==
= To install the plugin via WordPress Dashboard: =
1. In your WordPress admin dashboard, go to "Plugins" and click "Add New."
2. Click "Activate."
= To install the plugin manually: =
1. Download the plugin ZIP file from the [PageFlash WordPress Plugin Page](https://wordpress.org/plugins/pageflash/).
2. Click the "Upload Plugin" button and select the ZIP file you downloaded.
3. Click "Install Now" and then "Activate."
== Frequently Asked Questions ==
= How do I enable PageFlash for a specific post or page? =
After activation, go to the post or page where you want to enable PageFlash's headless browsing features. In the editor, look for the PageFlash settings panel to configure your preferences.
= Where should I check the plugin's features? =
- A. In Chrome's incognito mode.
- B. After logging out of the admin account.
- C. In Firefox's private browsing mode.
- D. In Safari's private browsing mode.
The best places to check the plugin's features are either in Chrome's incognito mode (Option A) or after logging out of the admin account (Option B). These methods ensure that the plugin works correctly without any interference from browser history, cookies, or admin privileges.
= Is PageFlash compatible with the latest version of WordPress? =
Yes, PageFlash is regularly tested and ensured to be compatible with the latest WordPress version.
== Screenshots ==
1. [Screenshot 1](https://github.com/theaminuldev/pageflash/src/images/screenshot.png): Describe the screenshot here.
== Changelog ==
= 1.1.0 =
* Fixed: Supply chain attack prevention
= 1.0.1 =
* Fixed: Issue with validateElement function in `pageflash-frontend`
* Improved: Added validation for timeoutFn in buildListenerOptions function
* Added : Confusion Clear FAQ plugin for better understanding
= 1.0.0 =
* Initial release
* Added: pageflash-frontend.js for frontend functionality
* Added: MetaBox class for admin settings
* Added: PAGEFLASH_ASSETS_PATH constant for asset management