Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ocReaper committed Jul 20, 2021
1 parent a189179 commit 8aa3bf1
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# wordpress-server-timing
# Wordpress Server Timing

Add Server-Timing header information from within your WordPress sites.

## Requirements

- PHP 7

## Installation

1. Copy the `wordpress-server-timing` folder to `wp-content/plugins`.
2. Activate the plugin through the WordPress admin panel.

## Usage

By default, the plugin measures only nine things, to keep it as light-weight as possible:

- WP setup (time between request start to WP internal timer start)
- Plugins loaded (time of loading all plugins including mu-plugins)
- Global query setup (time between plugins loaded and theme loading)
- Theme loaded (time of loading the theme and running on-the-fly functions.php logic)
- Non template logic (time between theme load and wp_loaded hook)
- Template processing (basically time of rendering the current template)
- API request processing (if API request is sent, otherwise 0)
- WPDB (time of all DB query if `SAVEQUERIES` is set to truthy)
- Total application run time

Once the package is successfully installed, you can see your timing information in the developer tools of your browser. Here's an example from Chrome:

![image](screenshot-devtoolbar.png)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
Binary file added screenshot-devtoolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8aa3bf1

Please sign in to comment.