Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Readme redo #21

Merged
merged 2 commits into from

1 participant

@tedivm
Owner

No description provided.

tedivm added some commits
@tedivm tedivm Updated Readme with "tedivm" standard eca595c
@tedivm tedivm Moved two tests into a new location
These two tests are not looking for corruption or issues, but are
additional optimizations that could allow the javascript files to be
further shrunk. Since they never worked for this project and cause no
corruption I’m considering them feature requests.
1790f62
@tedivm tedivm merged commit f864f71 into master

1 check passed

Details default The Travis CI build passed
@tedivm tedivm deleted the readme-redo branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 14, 2014
  1. @tedivm
  2. @tedivm

    Moved two tests into a new location

    tedivm authored
    These two tests are not looking for corruption or issues, but are
    additional optimizations that could allow the javascript files to be
    further shrunk. Since they never worked for this project and cause no
    corruption I’m considering them feature requests.
This page is out of date. Refresh to see the latest.
View
56 README.md
@@ -1,6 +1,16 @@
-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.
+# JShrink [![Build Status](https://travis-ci.org/tedivm/JShrink.png?branch=master)](https://travis-ci.org/tedivm/JShrink)
-### Usage
+[![Latest Stable Version](https://poser.pugx.org/tedivm/JShrink/v/stable.png)](https://packagist.org/packages/tedivm/JShrink)
+[![Total Downloads](https://poser.pugx.org/tedivm/JShrink/downloads.png)](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-
@@ -13,9 +23,49 @@ $minifiedCode = JShrink\Minifier::minify($js);
$minifiedCode = JShrink\Minifier::minify($js, array('flaggedComments' => false));
````
-### Results
+
+## 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.
+
+Until JShrink reaches a stable API with version 1.0 it is recommended that you
+review changes before even Minor updates, although bug fixes will always be
+backwards compatible.
+
+```
+"require": {
+ "tedivm/jshrink": "0.5.*"
+}
+```
+
+### Pear
+
+JShrink is also available through Pear.
+
+```
+$ pear channel-discover pear.tedivm.com
+$ pear install tedivm/JShrink
+```
+
+
+### Github
+
+Releases of JShrink are available on [Github](https://github.com/tedivm/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.
View
0  tests/minify/uglify/expect/ifreturn.js → tests/minify/requests/expect/ifreturn.js
File renamed without changes
View
0  tests/minify/uglify/expect/whitespace.js → tests/minify/requests/expect/whitespace.js
File renamed without changes
View
2  tests/minify/uglify/test/ifreturn.js → tests/minify/requests/test/ifreturn.js
@@ -5,5 +5,5 @@ function a(b) {
return 17;
}
- return 3;
+return 3;
}
View
0  tests/minify/uglify/test/whitespace.js → tests/minify/requests/test/whitespace.js
File renamed without changes
Something went wrong with that request. Please try again.