Updated Branches: refs/heads/master 2be13c758 -> cbfdc6f9f
start of node module usage documentation Project: http://git-wip-us.apache.org/repos/asf/cordova-plugman/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugman/commit/638d4b83 Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugman/tree/638d4b83 Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugman/diff/638d4b83 Branch: refs/heads/master Commit: 638d4b83ab94350c430e7200a9dad15603c9bfd8 Parents: 2be13c7 Author: Fil Maj <[email protected]> Authored: Fri May 17 22:37:17 2013 -0700 Committer: Fil Maj <[email protected]> Committed: Fri May 17 22:37:17 2013 -0700 ---------------------------------------------------------------------- README.md | 12 +++++++++++- 1 files changed, 11 insertions(+), 1 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-plugman/blob/638d4b83/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 2574e17..31bad05 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ This document defines tool usage. * BlackBerry 10 * Windows Phone 7 -## Usage +## Command Line Usage plugman --install --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]] plugman --uninstall --platform <ios|android|blackberr10|wp7|wp8> --project <directory> --plugin <name> [--www <directory>] [--plugins_dir <directory>] @@ -42,6 +42,16 @@ Other parameters: * `--www` defaults to the project's `www` folder location, but can be any directory that is to be used as cordova project application web assets. * `--variable` allows to specify certain variables at install time, necessary for certain plugins requiring API keys or other custom, user-defined parameters. Please see the [plugin specification](plugin_spec.md) for more information. +## Node Module Usage + + > require('plugman') + { install: [Function: installPlugin], + uninstall: [Function: uninstallPlugin], + fetch: [Function: fetchPlugin], + prepare: [Function: handlePrepare] } + +### `install` method + ## Example Plugins
