From 721e126d0d7d8226326ed8543503de8f50a98191 Mon Sep 17 00:00:00 2001
From: Daniel Freedman <dfreedm2@gmail.com>
Date: Fri, 18 May 2012 16:04:10 -0700
Subject: [PATCH] update readme for deploy

---
 tools/README.md | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/tools/README.md b/tools/README.md
index ce548db8..a0ee0a6a 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -1,22 +1,23 @@
-# Understanding and Using Minification
+# Minification and Deployment
+## Understanding and Using Minification
 
 Enyo comes with a minification tool based on NodeJS and UglifyJS.
 
 This tool can be used to compress the framework, other libraries, and applications, and will keep load order intact as well as correct url paths in css.
 
-## Why compress?
+### Why compress?
 
 Compressing enyo apps greatly reduces load times of appliactions, as well as reducing overall code size.
 
 This way, you can be very verbose in the documentation of your source code, without that impacting the performance of your application in production.
 
-## What is compressed
+### What is compressed
 
 For enyo, the libraries, and your code: **external assets such as images will not be copied or moved**.
 
 Instead, the CSS url paths are fixed up to reference the new path from the build location.
 
-## How to compress
+### How to compress
 
 To compress your application, you must enter the `minify` folder and run one of the scripts.
 - On Windows, just double click on `minify.bat`
@@ -28,7 +29,7 @@ Any libraries referenced in your `package.js` manifest will be built into your a
 
 **NOTE:** The `package.js` file inside the `minify` folder is mandatory, and only references your app's `package.js` to keep paths correct. Do not modify this.
 
-## What comes out?
+### What comes out?
 
 After running the minify script, a new folder `build` will be located next to your `source` directory.
 
@@ -39,3 +40,19 @@ In it will be 4 files:
 - app.js
 
 These files will be loaded in the given order by `index.html`.
+
+## Deployment
+
+The deploy scripts included here will make a production ready copy of your application, and copy it into a packeagable folder.
+
+### How to run
+
+Just execute the platform specific `deploy` script.
+
+### What comes out?
+
+The output of the `deploy` scripts will minify your appliaction, and copy the necessary files into `deploy/<appname>-<date>-<time>/`.
+
+If the libraries have a compatible `deploy` script, they will be executed, and a minimal copy will be placed in the deployment's lib folder.
+
+If no `deploy` script is found for the library, all of the library is copied into the lib folder to provide maximum safety.