Permalink
Browse files

fix API.md formatting

  • Loading branch information...
1 parent 6f5fe5e commit f27062582a2e7d98f6931c25aa6eb67b8f95cc3b @bjouhier bjouhier committed Feb 23, 2012
Showing with 4 additions and 0 deletions.
  1. +2 −0 API.md
  2. +2 −0 janzip/janzip.js
View
2 API.md
@@ -7,8 +7,10 @@ Simple API to create a zip archive. No external dependencies (except streamline.
Creates a zip archive.
Uses _deflate_ compression by default. You can override this by passing
`options = { zipMethod: zip.store }`
+
** `options.filter` optional function to filter the contents of directories.
Called as `filter(_, filename, parentEntry)`.
+
** `options.transform` optional function to transform the contents of files.
Called as `transform(_, contents, entry)` where `contents` is a buffer (not a string).
View
@@ -24,8 +24,10 @@ var zlib = require("zlib");
/// Creates a zip archive.
/// Uses _deflate_ compression by default. You can override this by passing
/// `options = { zipMethod: zip.store }`
+///
/// ** `options.filter` optional function to filter the contents of directories.
/// Called as `filter(_, filename, parentEntry)`.
+///
/// ** `options.transform` optional function to transform the contents of files.
/// Called as `transform(_, contents, entry)` where `contents` is a buffer (not a string).
///

0 comments on commit f270625

Please sign in to comment.