Skip to content

Commit

Permalink
Updates readme and version numbers for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
NielsdeBlaauw committed Sep 21, 2020
1 parent 34037e6 commit 1071a30
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 7 deletions.
Binary file added .wordpress-org/icon-128x128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/icon-256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .wordpress-org/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Query monitor Twig profile

**Query Monitor Twig profile is available in the [WordPress plugin repository](https://wordpress.org/plugins/query-monitor-twig-profile/)**.

Displays [Twig](https://twig.symfony.com/) profiler output in [Query Monitor](https://github.com/johnbillion/query-monitor).

Automatically works with [Timber](https://github.com/timber/timber).

![Screenshot showing the Twig Profile panel for Query Monitor](.wordpress-org/screenshot-1.png)
Expand All @@ -12,6 +15,9 @@ Find out which pages are slow, and why! Immediately see profiling information fr

Automatically integrates with Timber.

- Support for dark mode.
- Clickable links to profiled templates in your preferred editor.

## Installation

1. Install the plugin
Expand Down
2 changes: 1 addition & 1 deletion query-monitor-twig-profile.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* Plugin Name: Query monitor Twig profile
* Description: Displays Twig profiler output in Query Monitor. Automatically works with Timber.
* Version: 1.0.3
* Version: 1.1.0
* Plugin URI: https://github.com/NielsdeBlaauw/query-monitor-twig-profile
* Author: Niels de Blaauw
* Author URI: https://actd.nl/
Expand Down
27 changes: 21 additions & 6 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,35 +1,46 @@
=== Query monitor Twig profile ===
Contributors: nielsdeblaauw
Tags: timber, twig, query monitor, performance, profile, speed, template, theme
Tags: timber, twig, query monitor, performance, profile, speed, template, theme, developer, development, debug
Requires at least: 4.9.0
Tested up to: 5.5.1
Requires PHP: 7.0
Stable tag: 1.0.3
Stable tag: 1.1.0
License: MIT
License URI: https://raw.githubusercontent.com/NielsdeBlaauw/query-monitor-twig-profile/master/LICENSE

Displays Twig profiler output in Query Monitor.

== Description ==
Find out which pages are slow, and why! Immediately see profiling information from twig in your Query Monitor toolbar.
Find out which pages are slow, and why! Immediately see profiling information from twig in your [Query Monitor](https://wordpress.org/plugins/query-monitor/) toolbar.

The Twig profile extension for Query Monitor helps you notice which templates are used on a page and where the time rendering the page is spent.

Kind of like the ['What the file' plugin](https://wordpress.org/plugins/what-the-file/), but for Twig and with timing information.

Automatically integrates with Timber.

- Support for dark mode.
- Clickable links to profiled templates in your preferred editor.

== Installation ==
1. Install the plugin.
2. Activate it.
3. Check the 'Twig profile' tab in Query Monitor.
4. Speed up your site!

Alternatively, you can use [wpackagist](https://wpackagist.org/search?q=query-monitor-twig-profile&type=plugin&search=) or [packagist](https://packagist.org/packages/nielsdeblaauw/query-monitor-twig-profile).

You can also download specific releases and the development version from [GitHub](https://github.com/NielsdeBlaauw/query-monitor-twig-profile/releases).

== Frequently Asked Questions ==
# Can I use it with other frameworks that use twig?
Definitely. Just add a twig profiler extension to your twig instance and submit it to the collector.

```
`
if ( function_exists( 'NdB\QM_Twig_Profile\collect' ) ) {
$twig = \NdB\QM_Twig_Profile\collect( $twig );
}
```
`

= Privacy Statement =
Query Monitor Twig Profile is private by default and always will be. It does not persistently store any of the data that it collects. It does not send data to any third party, nor does it include any third party resources.
Expand All @@ -39,7 +50,7 @@ Query Monitor Twig Profile is private by default and always will be. It does not
2. The Twig profile tab in Query Monitor (dark mode)

== Changelog ==
next
1.1.0
* Support for dark mode.
* Support direct links to the templates in the editor.
* Makes it easier to profile a custom Twig instance.
Expand All @@ -60,3 +71,7 @@ next

1.0.0:
* Initial release.

== Development ==

This open source tool is developed in a public [GitHub repository](https://github.com/NielsdeBlaauw/query-monitor-twig-profile). If you have any feature requests, found an issue or want to contribute check out the repository.

0 comments on commit 1071a30

Please sign in to comment.