Permalink
Browse files

Moving 'archive' option doc changes to docs folder, which generates R…

…EADME.md.
  • Loading branch information...
1 parent 998a530 commit 9b79bc9ef278fcad3fcbdfa4506b9e5538f1e47d @TomGault TomGault committed Dec 6, 2013
Showing with 5 additions and 1 deletion.
  1. +5 −1 docs/compress-options.md
View
@@ -2,19 +2,23 @@
## archive
Type: `String` or `Function`
+Modes: `zip` `tar`
This is used to define where to output the archive. Each target can only have one output file.
If the type is a Function it must return a String.
+*This option is only appropriate for many-files-to-one compression modes like zip and tar. For gzip for example, please use grunt's standard src/dest specifications.*
+
## mode
Type: `String`
This is used to define which mode to use, currently supports `gzip`, `deflate`, `deflateRaw`, `tar`, `tgz` (tar gzip) and `zip`.
Automatically detected per dest:src pair, but can be overridden per target if desired.
-## level (zip only)
+## level
Type: `Integer`
+Modes: `zip`
Default: 1
Sets the level of archive compression.

0 comments on commit 9b79bc9

Please sign in to comment.