comfusion/hyperdrive

The fastest way to load pages in WordPress.

Installs: 4

Dependents: 0

Suggesters: 0

Type:wordpress-plugin

v1.0.0-beta.9 2017-06-15 18:08 UTC

README

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 comfusion/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://git.habd.as/comfusion/hyperdrive/raw/branch/master/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