Minor readme cleanup: word wrapping, fixing links

This commit is contained in:
Jeff Kaufman
2012-10-10 18:05:11 -04:00
parent 775cc36de6
commit a88290173b
+22 -9
View File
@@ -1,12 +1,19 @@
# ngx_pagespeed # ngx_pagespeed
This is the [nginx](http://nginx.org/) port of [mod_pagespeed](https://developers.google.com/speed/pagespeed/mod). This is the [nginx](http://nginx.org/) port of
[mod_pagespeed](https://developers.google.com/speed/pagespeed/mod).
**ngx_pagespeed is a work in progress**, and only a few of the mod_pagespeed filters are currently functional. If you are interested in test-driving the module, or contributing to the project, please follow the instructions below, and do provide feedback if you run into any issues or questions! **ngx_pagespeed is a work in progress**, and only a few of the mod_pagespeed
filters are currently functional. If you are interested in test-driving the
module, or contributing to the project, please follow the instructions below,
and do provide feedback if you run into any issues or questions!
--- ---
ngx_pagespeed speeds up your site and reduces page load time by automatically applying web performance best practices to pages, and associated assets (CSS, JavaScript, images) without requiring that you modify your existing content or workflow. Features (will) include: ngx_pagespeed speeds up your site and reduces page load time by automatically
applying web performance best practices to pages, and associated assets (CSS,
JavaScript, images) without requiring that you modify your existing content or
workflow. Features (will) include:
- Image optimization: stripping meta-data, dynamic resizing, recompression - Image optimization: stripping meta-data, dynamic resizing, recompression
- CSS & JavaScript minification, concatenation, inlining, and outlining - CSS & JavaScript minification, concatenation, inlining, and outlining
@@ -14,22 +21,25 @@ ngx_pagespeed speeds up your site and reduces page load time by automatically ap
- Deferring image and JavaScript loading - Deferring image and JavaScript loading
- HTML rewriting - HTML rewriting
- Cache lifetime extension - Cache lifetime extension
- and [more](http://igrigorik.mtv.corp.google.com:8080/speed/docs/mod_pagespeed/config_filters) - and [more](https://developers.google.com/speed/docs/mod_pagespeed/config_filters)
## How to build ## How to build
nginx does not support dynamic loading of modules. You need to add ngx_pagespeed as a build time dependency, and to do that you have to first build the pagespeed optimization library. nginx does not support dynamic loading of modules. You need to add ngx_pagespeed
as a build time dependency, and to do that you have to first build the pagespeed
optimization library.
First build mod_pagespeed, following these instructions: First build mod_pagespeed, following these instructions:
http://code.google.com/p/modpagespeed/wiki/HowToBuild https://developers.google.com/speed/docs/mod_pagespeed/build_from_source
Then build the pagespeed optimization library: Then build the pagespeed optimization library:
$ cd /where/you/built/mod_pagespeed/src/net/instaweb/automatic $ cd /where/you/built/mod_pagespeed/src/net/instaweb/automatic
$ make all $ make all
Then move the mod_pagespeed directory to a parallel directory to your ngx_pagespeed checkout: Then move the mod_pagespeed directory to a parallel directory to your
ngx_pagespeed checkout:
$ cd /path/to/ngx_pagespeed $ cd /path/to/ngx_pagespeed
$ mv /where/you/built/mod_pagespeed /path/to/mod_pagespeed $ mv /where/you/built/mod_pagespeed /path/to/mod_pagespeed
@@ -40,7 +50,9 @@ Now build nginx:
$ auto/configure --add-module=/path/to/ngx_pagespeed $ auto/configure --add-module=/path/to/ngx_pagespeed
$ make install $ make install
While ngx_pagespeed doesn't need to be anywhere specific in relation to nginx, the mod_pagespeed directory and the ngx_pagespeed directory must have the same parent. While ngx_pagespeed doesn't need to be anywhere specific in relation to nginx,
the mod_pagespeed directory and the ngx_pagespeed directory must have the same
parent.
## How to use ## How to use
@@ -48,6 +60,7 @@ To your nginx.conf add to the main block or to a server or location block:
pagespeed on; pagespeed on;
To confirm that the module is working, fetch a page and check that you see the following comment in the source: To confirm that the module is working, fetch a page and check that you see the
following comment in the source:
<!-- Processed through ngx_pagespeed using PSOL version 0.10.0.0 --> <!-- Processed through ngx_pagespeed using PSOL version 0.10.0.0 -->