mirror/minify
1
0
Fork 0
mirror of https://github.com/mrclay/minify.git synced 2025-04-21 04:41:54 +02:00
Code Issues Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Steve Clay 2008-06-25 02:59:06 +00:00
parent 7bf6df24fa
commit dcd99a1e51
2 changed files with 12 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HISTORY
View File

@ -1,5 +1,9 @@
Minify Release History
Version 2.0.2 beta (2008-06-24)
* Fast new cache system. Cached files served almost 3x as fast.
* Dropped support of compress encoding (though HTTP_Encoder still supports it)
Version 2.0.1 (2008-05-31)
* E_STRICT compliance (Cache_Lite_File).

43
README
View File

@ -1,41 +1,20 @@
WELCOME TO MINIFY 2.0!
Currently the documentation at http://code.google.com/p/minify/ applies to
the earlier 1.x release, but this will be updated in due time.
SETUP
Minify is a library of files inside the "lib" directory. Wherever you
place "lib", it needs to be in your include_path, and should be
access-protected or outside of DOCUMENT_ROOT. Alternately you can dump
the contents of "lib" into an existing directory in your include_path.
TESTING
1. Place the "web" directory somewhere in DOCUMENT_ROOT.
2. Edit "config.php" to manually add "lib" to the include_path.
3. To enable server-side caching, set $minifyCachePath to a PHP-writeable directory
4. Visit http://yourdomain.com/path/to/web/examples/1/
This page should contain 2 "PASS"es. It may take a few seconds to minify
jQuery. If you've enabled caching this wait will no longer be needed.
5. Visit http://yourdomain.com/path/to/web/test/test_all.php
This will run all unit tests. You can call the tests individually to see
more details.
MINIFY OVERVIEW
Minify is an HTTP content server. It compresses sources of content
(usually files), combines the result and serves it with appropriate
HTTP headers. These headers can allow clients to perform conditional
GETs (serving content only when clients do not have a valid cache)
or tell clients to cache the file until a given date/time.
More info: http://code.google.com/p/minify/
INSTALLATION AND USAGE: http://code.google.com/p/minify/wiki/UserGuide
UNIT TESTING & EXAMPLES: http://code.google.com/p/minify/wiki/TestingMinify
MINIFY OVERVIEW
Minify works with Minify_Source objects. These usually represent a file
on disk, but a source can also be content on hand or from a database.
on disk, but a source can also be a string in memory or from a database.
Sources with known "last modified" timestamps allow Minify to implement
server-side caching and conditional GETs.
@ -60,12 +39,6 @@ Minify::serve('Files', array(
The above creates an instance of Minify_Controller_Files, which creates
source objects from the 'files' option, and supplies other default options.
MINIFY USAGE
Example 1 shows an example of using Minify to serve external CSS and JS files
with far-off Expires headers. Clients will always have up-to-date versions
because Minify_Build is used to time stamp the URLs.
FILE ENCODINGS
Minify *should* work fine with files encoded in UTF-8 or other 8-bit