diff options
Diffstat (limited to 'vendor/JShrink/README.md')
| -rw-r--r-- | vendor/JShrink/README.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/vendor/JShrink/README.md b/vendor/JShrink/README.md new file mode 100644 index 000000000..940af38c1 --- /dev/null +++ b/vendor/JShrink/README.md @@ -0,0 +1,61 @@ +# JShrink [](https://travis-ci.org/tedivm/JShrink) + +[](https://github.com/tedivm/JShrink/blob/master/LICENSE) +[](https://packagist.org/packages/tedivm/JShrink) +[](https://coveralls.io/r/tedivm/JShrink?branch=master) +[](https://packagist.org/packages/tedivm/JShrink) + + +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 +<?php +include('vendor/autoload.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 + + +## Installing + +### Composer + +Installing JShrink can be done through a variety of methods, although Composer is +recommended. + +```yaml +"require": { + "tedivm/jshrink": "~1.0" +} +``` + +### Github + +Releases of JShrink are available on [Github](https://github.com/tedious/JShrink/releases). + + +## License + +JShrink is licensed under the BSD License. See the LICENSE file for details. + +In the spirit of open source, use of this library for evil is discouraged but not prohibited. |