README.txt 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. WELCOME TO MINIFY!
  2. Minify is an HTTP content server. It compresses sources of content
  3. (usually files), combines the result and serves it with appropriate
  4. HTTP headers. These headers can allow clients to perform conditional
  5. GETs (serving content only when clients do not have a valid cache)
  6. and tell clients to cache the file for a period of time.
  7. More info: http://code.google.com/p/minify/
  8. WORDPRESS USER?
  9. These WP plugins integrate Minify into WordPress's style and script hooks to
  10. get you set up faster.
  11. http://wordpress.org/extend/plugins/bwp-minify/
  12. http://wordpress.org/extend/plugins/w3-total-cache/
  13. INSTALLATION
  14. Place the /min/ directory as a child of your DOCUMENT_ROOT
  15. directory: i.e. you will have: /home/example/www/min
  16. You can see verify that it is working by visiting these two URLs:
  17. http://example.org/min/?f=min/quick-test.js
  18. http://example.org/min/?f=min/quick-test.css
  19. If your server supports mod_rewrite, this URL should also work:
  20. http://example.org/min/f=min/quick-test.js
  21. CONFIGURATION & USAGE
  22. See the MIN.txt file and http://code.google.com/p/minify/wiki/UserGuide
  23. Minify also comes with a URI Builder application that can help you write URLs
  24. for use with Minify or configure groups of files. See here for details:
  25. http://code.google.com/p/minify/wiki/BuilderApp
  26. The cookbook also provides some more advanced options for minification:
  27. http://code.google.com/p/minify/wiki/CookBook
  28. UPGRADING
  29. See UPGRADING.txt for instructions.
  30. UNIT TESTING:
  31. 1. Place the /min_unit_tests/ directory as a child of your DOCUMENT_ROOT
  32. directory: i.e. you will have: /home/example/www/min_unit_tests
  33. 2. To run unit tests, access: http://example.org/min_unit_tests/test_all.php
  34. (If you wish, the other test_*.php files can be run to test individual
  35. components with more verbose output.)
  36. 3. Remove /min_unit_tests/ from your DOCUMENT_ROOT when you are done.
  37. FILE ENCODINGS
  38. Minify *should* work fine with files encoded in UTF-8 or other 8-bit
  39. encodings like ISO 8859/Windows-1252. By default Minify appends
  40. ";charset=utf-8" to the Content-Type headers it sends.
  41. Leading UTF-8 BOMs are stripped from all sources to prevent
  42. duplication in output files, and files are converted to Unix newlines.