Contents of /contributions/sandbox/jamesandres/shrinksafe/README

# $Id: README,v 1.0 2007/11/01 14:22:35 jamesandres Exp $

ShrinkSafe Javascript Compressor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ShrinkSafe javascript compressor is a Java 'jar' package that utilizes the
Rhino engine for it's javascript parsing / compression.  ShrinkSafe is known
for providing good, for the average person, levels of compression while almost
never causing incompatibilities and or bugs (like the Dean Edwards packer
sometimes does).

ShrinkSafe is Java based, so it requires a working Java JRE to operate!

Java can be easily installed on: Windows, Linux (Debian, Ubuntu, Redhat, etc..),
and many other popular operating systems.

All this script requires is access to run java, and information about where
the 'java' executable can be found.  Usually this is '/usr/bin/java'.

PS: For the curious, I've tested this module using the kaffe JRE with good
success.  It does crash on occasion, in my experience.


The ShrinkSafe Druapl Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~


This module provides what amounts to a wrapper around the shrinksafe utility.
With minimal modification to your theme (page.tpl.php) this module will compress
all your site's javascript files and even aggregate them (mash them into
one giant javascript file).

Warnings and Notes
~~~~~~~~~~~~~~~~~~

The shrinksafe module was written by me, James Andres, to scratch my own itch
on a few of my projects.  I wouldn't say it's "thoroughly tested software" so
you'll probably want to do you're own tested before doing anything important
with it.

This work is not endorsed by the authors of dojo or ShrinkSafe.


James Andres.
1	# $Id: README,v 1.0 2007/11/01 14:22:35 jamesandres Exp $
2
3	ShrinkSafe Javascript Compressor
4	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
6	The ShrinkSafe javascript compressor is a Java 'jar' package that utilizes the
7	Rhino engine for it's javascript parsing / compression. ShrinkSafe is known
8	for providing good, for the average person, levels of compression while almost
9	never causing incompatibilities and or bugs (like the Dean Edwards packer
10	sometimes does).
11
12	ShrinkSafe is Java based, so it requires a working Java JRE to operate!
13
14	Java can be easily installed on: Windows, Linux (Debian, Ubuntu, Redhat, etc..),
15	and many other popular operating systems.
16
17	All this script requires is access to run java, and information about where
18	the 'java' executable can be found. Usually this is '/usr/bin/java'.
19
20	PS: For the curious, I've tested this module using the kaffe JRE with good
21	success. It does crash on occasion, in my experience.
22
23
24	The ShrinkSafe Druapl Module
25	~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
27
28	This module provides what amounts to a wrapper around the shrinksafe utility.
29	With minimal modification to your theme (page.tpl.php) this module will compress
30	all your site's javascript files and even aggregate them (mash them into
31	one giant javascript file).
32
33	Warnings and Notes
34	~~~~~~~~~~~~~~~~~~
35
36	The shrinksafe module was written by me, James Andres, to scratch my own itch
37	on a few of my projects. I wouldn't say it's "thoroughly tested software" so
38	you'll probably want to do you're own tested before doing anything important
39	with it.
40
41	This work is not endorsed by the authors of dojo or ShrinkSafe.
42
43
44	James Andres.