build doc

README.md

@@ -1,3 +1,150 @@
-# grunt-contrib-uglify [![Build Status](https://secure.travis-ci.org/gruntjs/grunt-contrib-uglify.png?branch=master)](http://travis-ci.org/gruntjs/grunt-contrib-uglify) (unreleased, for grunt v0.4.0a)
+# grunt-contrib-uglify [![Build Status](https://secure.travis-ci.org/gruntjs/grunt-contrib-uglify.png?branch=master)](http://travis-ci.org/gruntjs/grunt-contrib-uglify)
 
 > Minify files with UglifyJS.
+
+_Note that this plugin has not yet been released, and only works with the latest bleeding-edge, in-development version of grunt. See the [When will I be able to use in-development feature 'X'?](https://github.com/gruntjs/grunt/blob/devel/docs/faq.md#when-will-i-be-able-to-use-in-development-feature-x) FAQ entry for more information._
+
+## Getting Started
+_If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide._
+
+From the same directory as your project's [Gruntfile][Getting Started] and [package.json][], install this plugin with the following command:
+
+```bash
+npm install grunt-contrib-uglify --save-dev
+```
+
+Once that's done, add this line to your project's Gruntfile:
+
+```js
+grunt.loadNpmTasks('grunt-contrib-uglify');
+```
+
+If the plugin has been installed correctly, running `grunt --help` at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a `devDependency`, which ensures that it will be installed whenever the `npm install` command is run.
+
+[grunt]: http://gruntjs.com/
+[Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md
+[package.json]: https://npmjs.org/doc/json.html
+
+
+## The uglify task
+
+#### Overview
+
+This task is a [multi task](types_of_tasks.md), meaning that grunt will automatically iterate over all `uglify` targets if a target is not specified.
+
+grunt-contrib-uglify primarily delegates to [UglifyJS2](https://github.com/mishoo/UglifyJS2), so please consider the [UglifyJS documentation](http://lisperator.net/uglifyjs/) as required reading for advanced configuration.
+### UglifyJS options
+
+#### API Note:
+
+When in doubt, the options mimic the [UglifyJS2 api](http://lisperator.net/uglifyjs/) *except* where the command line API is found to be simpler (e.g. reusing options passed to `mangle_names` and `compute_char_frequency`.
+
+#### mangle
+Type: `Boolean`, `Object`  
+Default: `{}`
+
+Turn on or off mangling with default options. If an `Object` is specified, it is passed directly to `ast.mangle_names()` *and* `ast.compute_char_frequency()` (mimicking command line behavior).
+
+#### compress
+Type: `Boolean`, `Object`  
+Default: `{}`
+
+Turn on or off source compression with default options. If an `Object` is specified, it is passed directly to `UglifyJS2.Compressor()`.
+
+#### beautify
+Type: `Boolean`, `Object`  
+Default: `false`
+
+Turns on beautification of the generated source code. Any extra options passed are merged with the options sent to `UglifyJS2.OutputStream()`.
+
+#### source_map
+Type: `string`  
+Default: `undefined`
+
+Specify the sourcemap location to output.
+
+#### banner
+Type: `string`
+Default: `undefined`
+
+Specify a banner to prepend to the output source, e.g. license comments.
+
+### Usage examples
+
+##### All tasks are specified in an `uglify` block
+
+        uglify: {
+
+##### This is a multitask and options specified at the root level will be merged with each task
+
+          options: {
+            mangle : {
+              except : ['jQuery', 'Backbone']
+            }
+          },
+
+##### Just use default options to compress your source
+
+          default: {
+            files: {
+              'source.min.js': ['source.js']
+            }
+          },
+
+##### Compress your source only, no mangling
+
+          no_mangle: {
+            files: {
+              'source.min.js': ['source.js']
+            },
+            options : {
+              mangle : false
+            }
+          },
+
+##### Compress, mangle, and output source map
+
+          sourcemap: {
+            files: {
+              'source.min.js': ['source.js']
+            },
+            options : {
+              source_map : 'sourcemap.js'
+            }
+          },
+
+##### Beautify your compressed and mangled source
+
+          beautified: {
+            files: {
+              'source.min.js': ['source.js']
+            },
+            options : {
+              beautify : {
+                max_line_len : 120
+              }
+            }
+          }
+
+##### Banner comments
+
+          banner: {
+            files: {
+              'source.min.js': ['source.js']
+            },
+            options : {
+              banner: '/*! <%= pkg.name %> - v<%= pkg.version %> - ' +
+                      ' *  <%= grunt.template.today("yyyy-mm-dd") %> */'
+            }
+          }
+
+
+## Release History
+
+_(Nothing yet)_
+
+
+--
+Task submitted by <a href="http://benalman.com">"Cowboy" Ben Alman</a>.
+
+*Generated on Sun Nov 18 2012 07:27:10.*