vhs
/
hyperdrive
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
🚀 The fastest way to load pages in WordPress https://vhs.codeberg.page/code/hyperdrive/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
252 Commits
1 Branch
0 Tags
8.7 MiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'trunk'
${ noResults }
Go to file
vhs c795183fdc
refactor: 💡 update git links to eliminate redirect 		2 years ago
bin refactor: 💡 update git links to eliminate redirect 2 years ago
docs refactor: 💡 update git links to eliminate redirect 2 years ago
spec refactor: 💡 update git links to eliminate redirect 2 years ago
src refactor: 💡 update git links to eliminate redirect 2 years ago
tests ci(Travis): restore order to codesniffing 6 years ago
.distignore chore(distignore): udpate for plugin tests scaffold 6 years ago
.editorconfig chore(package): apply wp coding standards only to those items standards apply [ci skip] 6 years ago
.gitignore chore(gitignore): add vendor dir to gitignore 6 years ago
.travis.yml test($hyperdrive/integration): stop reporting integration coverage 6 years ago
CHANGELOG.md chore(release): 1.0.0-beta.9 6 years ago
COPYING revert(LICENSE): convert back to markdown and move into a namesake file 6 years ago
README.md refactor: 💡 update git links to eliminate redirect 2 years ago
bootstrap.php refactor: 💡 update git links to eliminate redirect 2 years ago
composer.json docs(package/composer): update plug-in homepage 4 years ago
composer.lock ci(Travis): restore order to codesniffing 6 years ago
kahlan-config.php chore(Kahlan): remove fast-fail option 6 years ago
logo.png Initial commit 6 years ago
package.json refactor: 💡 update git links to eliminate redirect 2 years ago
patchwork.json test($hyperdrive): add first passing unit tests 6 years ago
phpcs.ruleset.xml ci(Travis): streamline linting 6 years ago
phpunit.xml.dist refactor(package): move plugin files into ./src directory 6 years ago

README.md
Escape

Hyperdrive

The fastest way to load pages in WordPress.

Hyperdrive plugin for WordPress logo

Latest version on Packagist Supported PHP versions Supported WordPress versions Build status Code coverage

Hyperdrive is a WordPress plugin that increases site performance using modern Web standards. Based on initial testing Hyperdrive has been shown to reduce perceived latency in the Twenty Seventeen theme by 200-300%.

Translations: Pу́сский, Español, Português

How it works

Hyperdrive uses a performance optimization technique known as Fetch Injection available in supported browsers. Fetch Injection leverages Fetch, the modern replacement for Ajax.

Installation

Several installation options are available. Choose the one which best meets your skill level and desired workflow.

Ensign

To install the plugin manually, simply:

  1. Upload hyperdrive.php to the /wp-content/plugins/ directory,
  2. Activate the plugin through the Plugins menu in WordPress.

Lieutenant

To install and manage with Composer run the following from the WP installation directory:

composer require vhs/hyperdrive:1.0.x-dev

The above will download the Hyperdrive beta under version control and install it directly to the /wp-content/plugins directory. Run composer update to get the new and shiny.

Commander

The only thing here you may not recognize is rupa/z:

ssh user:pass@wordpressbox.tld
z plugins
curl -O https://code.vhs.codeberg.page/vhs/hyperdrive/raw/branch/trunk/src/hyperdrive.php
wp plugin activate hyperdrive

Todo before 1.0.0 release candidates

  • Only dequeue scripts if browser supports Fetch for backwards compatibility with older browsers
  • Integrate localization behaviors as shown here.
  • Test with a few different themes and open bugs and needed

Contributing

Hundreds of thousands of individuals and users rely on WordPress every day to consume and share information online. For that reason Hyperdrive has strict requirements for code contributions.

And though Hyperdrive may have a high bar for quality, please don't let that deter you from making contributions. We take on all comers.

Where possible project owners, collaborators and contributors should embrace the values of the Agile Manifesto:

  • Individuals and Interactions over Processes and Tools
  • Working Software over Comprehensive Documentation
  • Customer Collaboration over Contract Negotiation, and
  • Responding to Change over Following a Plan

Issues

Hyperdrive accepts any issue. Be it gratuitously worded, devoid of information or just plain dumb. Feedback is a gift and will be treated as such. No question is stupid, even the stupid ones.

Pull requests

Please open issues when creating PRs and PR against the issue to close it. This establishes a need (the issue) and helps separate the need from the implementation (the pull), resulting in more robust solutions.

Before working on a pull please install and configure EditorConfig for your editor or IDE to help normalize your code syntax with that of the project.

License

AGPL-3.0 or any later version