From 69019960c9dbdba2c176b2a568b440c673a17878 Mon Sep 17 00:00:00 2001 From: Steve Clay Date: Tue, 22 Sep 2015 13:06:25 -0400 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index dbdfb0d..0d3c6ab 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,18 @@ Welcome to Minify! Minify is an HTTP server for JS and CSS assets. It compresses and combines files and serves it with appropriate headers, allowing conditional GET or long-Expires. +| *Before* | ![7 requests](http://mrclay.org/wp-content/uploads/2008/09/fiddler_before.png) | +|----------|-----------------------------------------------------------------| +| *After* | ![2 requests](http://mrclay.org/wp-content/uploads/2008/09/fiddler_after.png) | + +The stats above are from a [brief walkthrough](http://mrclay.org/index.php/2008/09/19/minify-21-on-mrclayorg/) which shows how easy it is to set up Minify on an existing site. It eliminated 5 HTTP requests and reduced JS/CSS bandwidth by 70%. + +Relative URLs in CSS files are rewritten to compensate for being served from a different directory. + Wordpress User? =============== -Use a dedicated WordPress plugin for more deep integration and simpler installation. -Here are a couple we're aware of: +Consider instead using a dedicated WordPress plugin for more deep integration and simpler installation. E.g.: - [BWP Minify](http://wordpress.org/extend/plugins/bwp-minify/) - [W3 Total Cache](http://wordpress.org/extend/plugins/w3-total-cache/) @@ -32,15 +39,18 @@ Configuration & Usage See the MIN.txt file and the [user guide](https://github.com/mrclay/minify/blob/master/docs/UserGuide.wiki.md) -Minify also comes with a URI Builder application that can help you write URLs -for use with Minify or configure groups of files. See here for details: - https://github.com/mrclay/minify/blob/master/docs/BuilderApp.wiki.md +Minify also comes with a [URI Builder application](https://github.com/mrclay/minify/blob/master/docs/BuilderApp.wiki.md) that can help you write URLs +for use with Minify or configure groups of files. -The cookbook also provides some more advanced options for minification: - https://github.com/mrclay/minify/blob/master/docs/CookBook.wiki.md +See the [cookbook](https://github.com/mrclay/minify/blob/master/docs/CookBook.wiki.md) for more advanced options for minification. More [docs are available](https://github.com/mrclay/minify/tree/master/docs). +Support +======= + +[Google Group](http://groups.google.com/group/minify) + Unit Testing ============ @@ -54,7 +64,6 @@ components with more verbose output.) 3. Remove /min_unit_tests/ from your DOCUMENT_ROOT when you are done. - File Encodings ============== @@ -64,3 +73,16 @@ encodings like ISO 8859/Windows-1252. By default Minify appends Leading UTF-8 BOMs are stripped from all sources to prevent duplication in output files, and files are converted to Unix newlines. + +Warnings +======== + +* Minify is designed for efficiency, but, for very high traffic sites, it will probably serve files slower than your HTTPd due to the CGI overhead of PHP. See the [FAQ](https://github.com/mrclay/minify/blob/master/docs/FAQ.wiki.md#how-fast-is-it) and [CookBook](https://github.com/mrclay/minify/blob/master/docs/CookBook.wiki.md) for more info. + * If you combine a lot of CSS, watch out for [IE's 4096 selectors-per-file limit](http://www.thecssdiv.co.uk/2009/08/28/another-weird-ie6-bug/), affecting IE 6 through 8. + +Acknowledgments +=============== + +Minify was inspired by [jscsscomp](http://code.google.com/p/jscsscomp/) by Maxim Martynyuk and by the article [Supercharged JavaScript](http://www.hunlock.com/blogs/Supercharged_Javascript) by Patrick Hunlock. + +The [JSMin library](http://www.crockford.com/javascript/jsmin.html) used for !JavaScript minification was originally written by Douglas Crockford and was [ported to PHP](https://github.com/mrclay/jsmin-php) by Ryan Grove specifically for use in Minify.