summaryrefslogtreecommitdiff
path: root/plugins/Minify/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/Minify/README')
-rw-r--r--plugins/Minify/README34
1 files changed, 34 insertions, 0 deletions
diff --git a/plugins/Minify/README b/plugins/Minify/README
new file mode 100644
index 000000000..f7763735e
--- /dev/null
+++ b/plugins/Minify/README
@@ -0,0 +1,34 @@
+The Minify plugin minifies your CSS and Javascript, removing whitespace and comments.
+
+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
+============
+add "addPlugin('minify',
+ array('setting'=>'value', 'setting2'=>'value2', ...);"
+to the bottom of your config.php
+
+Settings
+========
+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());
+