Permalink
Browse files

fix API.md formatting

  • Loading branch information...
1 parent f270625 commit 8fbea7086cb30d22fa2992c14f25db44a8e6e20e @bjouhier bjouhier committed Feb 23, 2012
Showing with 8 additions and 12 deletions.
  1. +4 −6 API.md
  2. +4 −6 janzip/janzip.js
View
10 API.md
@@ -6,12 +6,10 @@ Simple API to create a zip archive. No external dependencies (except streamline.
* `archive = new zip.Zip(outStream[, options])`
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.
+ `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).
* `archive.add(_, entry)`
View
@@ -23,12 +23,10 @@ var zlib = require("zlib");
/// * `archive = new zip.Zip(outStream[, options])`
/// 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.
+/// `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).
///
exports.Zip = function(outStream, options) {

0 comments on commit 8fbea70

Please sign in to comment.