Skip to content

Commit 31719be

Browse files
committed
docs: update readme to reflect image pushing
1 parent 657c74c commit 31719be

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Server Push is a HTTP/2 concept which allows the server to speculatively start sending resources to the client. This can potentially speed up initial page load times: the browser doesn't have to parse the HTML page and find out which other resources to load, instead the server can start sending them immediately. [(source)](http://blog.xebia.com/http2-server-push/)
1111

1212
This package aims to provide the _easiest_ experience for adding Server Push to your responses.
13-
Simply route your requests through the `AddHttp2ServerPush` middleware and it will automatically create and attach the `Link` headers necessary to implement Server Push for your CSS and JS assets.
13+
Simply route your requests through the `AddHttp2ServerPush` middleware and it will automatically create and attach the `Link` headers necessary to implement Server Push for your CSS, JS and Image assets.
1414

1515
## Installation
1616

@@ -32,9 +32,11 @@ protected $middleware = [
3232

3333
## Usage
3434

35-
When you route a request through the `AddHttp2ServerPush` middleware, the response is scanned for any `link` or `script` tags that could benefit from being loaded using Server Push.
35+
When you route a request through the `AddHttp2ServerPush` middleware, the response is scanned for any `link`, `script` or `img` tags that could benefit from being loaded using Server Push.
3636
These assets will be added to the `Link` header before sending the response to the client. Easy!
3737

38+
**Note:** To push an image asset, it must have one of the following extensions: `bmp`, `gif`, `jpg`, `jpeg`, `png` or `tiff`.
39+
3840
## Testing
3941

4042
``` bash

0 commit comments

Comments
 (0)