mirror of
https://github.com/mrclay/minify.git
synced 2025-08-11 00:24:11 +02:00
Make README into Markdown
This commit is contained in:
53
README.md
53
README.md
@@ -1,34 +1,39 @@
|
||||
WELCOME TO MINIFY!
|
||||
Welcome to Minify!
|
||||
==================
|
||||
|
||||
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)
|
||||
and tell clients to cache the file for a period of time.
|
||||
|
||||
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)
|
||||
and tell clients to cache the file for a period of time.
|
||||
More info: http://code.google.com/p/minify/
|
||||
|
||||
|
||||
WORDPRESS USER?
|
||||
Wordpress User?
|
||||
===============
|
||||
|
||||
These WP plugins integrate Minify into WordPress's style and script hooks to
|
||||
get you set up faster.
|
||||
http://wordpress.org/extend/plugins/bwp-minify/
|
||||
http://wordpress.org/extend/plugins/w3-total-cache/
|
||||
- [BWP Minify](http://wordpress.org/extend/plugins/bwp-minify/)
|
||||
- [W3 Total Cache](http://wordpress.org/extend/plugins/w3-total-cache/)
|
||||
|
||||
|
||||
INSTALLATION
|
||||
Installation
|
||||
============
|
||||
|
||||
Place the /min/ directory as a child of your DOCUMENT_ROOT
|
||||
directory: i.e. you will have: /home/example/www/min
|
||||
|
||||
You can see verify that it is working by visiting these two URLs:
|
||||
http://example.org/min/?f=min/quick-test.js
|
||||
http://example.org/min/?f=min/quick-test.css
|
||||
- http://example.org/min/?f=min/quick-test.js
|
||||
- http://example.org/min/?f=min/quick-test.css
|
||||
|
||||
If your server supports mod_rewrite, this URL should also work:
|
||||
http://example.org/min/f=min/quick-test.js
|
||||
- http://example.org/min/f=min/quick-test.js
|
||||
|
||||
CONFIGURATION & USAGE
|
||||
Configuration & Usage
|
||||
=====================
|
||||
|
||||
See the MIN.txt file and http://code.google.com/p/minify/wiki/UserGuide
|
||||
|
||||
@@ -39,30 +44,32 @@ for use with Minify or configure groups of files. See here for details:
|
||||
The cookbook also provides some more advanced options for minification:
|
||||
http://code.google.com/p/minify/wiki/CookBook
|
||||
|
||||
UPGRADING
|
||||
Upgrading
|
||||
=========
|
||||
|
||||
See UPGRADING.txt for instructions.
|
||||
|
||||
|
||||
UNIT TESTING:
|
||||
Unit Testing
|
||||
============
|
||||
|
||||
1. Place the /min_unit_tests/ directory as a child of your DOCUMENT_ROOT
|
||||
1. Place the /min_unit_tests/ directory as a child of your DOCUMENT_ROOT
|
||||
directory: i.e. you will have: /home/example/www/min_unit_tests
|
||||
|
||||
2. To run unit tests, access: http://example.org/min_unit_tests/test_all.php
|
||||
|
||||
(If you wish, the other test_*.php files can be run to test individual
|
||||
(If you wish, the other test_*.php files can be run to test individual
|
||||
components with more verbose output.)
|
||||
|
||||
3. Remove /min_unit_tests/ from your DOCUMENT_ROOT when you are done.
|
||||
|
||||
|
||||
FILE ENCODINGS
|
||||
File Encodings
|
||||
==============
|
||||
|
||||
Minify *should* work fine with files encoded in UTF-8 or other 8-bit
|
||||
Minify *should* work fine with files encoded in UTF-8 or other 8-bit
|
||||
encodings like ISO 8859/Windows-1252. By default Minify appends
|
||||
";charset=utf-8" to the Content-Type headers it sends.
|
||||
";charset=utf-8" to the Content-Type headers it sends.
|
||||
|
||||
Leading UTF-8 BOMs are stripped from all sources to prevent
|
||||
Leading UTF-8 BOMs are stripped from all sources to prevent
|
||||
duplication in output files, and files are converted to Unix newlines.
|
||||
|
||||
|
Reference in New Issue
Block a user