Merge commit 'refs/merge-requests/166' of git://gitorious.org/statusnet/mainline...

[quix0rs-gnu-social.git] / plugins / Minify / README

diff --git a/plugins/Minify/README b/plugins/Minify/README
index 7fb7e239a31ccd12b0ab19b8606e97b1ba3b7b2a..97fa7dadf9e01e639095346ed4aba829197c0e99 100644 (file)
--- a/plugins/Minify/README
+++ b/plugins/Minify/README
@@ -1,7 +1,13 @@
-The Minify plugin minifies your CSS and Javascript, removing whitespace and comments.
+The Minify plugin minifies your CSS and Javascript, removing whitespace and
+comments.
 
-Note that if enabled this plugin and use a theme server
-    ($config['theme']['server']), your theme server will not be used.
+Note that if enabled this plugin and use a theme server,
+    (if any of $config['theme']['server'], $config['theme']['path'],
+    $config['theme']['dir'] are set) theme CSS will not be minified.
+
+This plugin will use memcache, if it is available, for storing minified inline
+    and file javascript and css. Because minification is non-trivial, using
+    memcache is recommended.
 
 Installation
 ============
@@ -11,10 +17,18 @@ to the bottom of your config.php
 
 Settings
 ========
-None at the moment
+minifyInlineJs (true): Minify inline javascript.
+    Because caching isn'tas effective for inline resources (due to its more
+    dynamic nature) than static files, minifying inline resources may adversely
+    affect performance for higher volume sites. Testing (and memcache usage)
+    are highly recommended.
+minifyInlineCss (true): Minify inline CSS.
+    Because caching isn'tas effective for inline resources (due to its more
+    dynamic nature) than static files, minifying inline resources may adversely
+    affect performance for higher volume sites. Testing (and memcache usage)
+    are highly recommended.
 
 Example
 =======
 
 addPlugin('minify', array());
-