summaryrefslogtreecommitdiff
path: root/lib/jshrink/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/jshrink/README.md')
-rw-r--r--lib/jshrink/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/jshrink/README.md b/lib/jshrink/README.md
new file mode 100644
index 000000000..4c024b5ea
--- /dev/null
+++ b/lib/jshrink/README.md
@@ -0,0 +1,21 @@
+JShrink is a php class that minifies javascript so that it can be delivered to the client quicker. This code can be used by any product looking to minify their javascript on the fly (although caching the results is suggested for performance reasons). Unlike many other products this is not a port into php but a native application, resulting in better performance.
+
+### Usage
+
+Minifying your code is simple call to a static function-
+
+````
+<?php
+// Basic (default) usage.
+$minifiedCode = JShrink\Minifier::minify($js);
+
+// Disable YUI style comment preservation.
+$minifiedCode = JShrink\Minifier::minify($js, array('flaggedComments' => false));
+````
+
+### Results
+
+* Raw - 586,990
+* Gzip - 151,301
+* JShrink - 371,982
+* JShrink and Gzip - 93,507