← Back to branch summary

~cordova-ubuntu/cordova-cli/trunk

« back to all changes in this revision

Viewing changes to node_modules/cordova/_vendor/plugman/0.19.1-dev/README.md

  • Committer: Robert Bruce Park
  • Date: 2014-02-26 21:27:56 UTC
  • mfrom: (44.1.5 3.4-release)
  • Revision ID: robert.park@canonical.com-20140226212756-6jmoiqugw0f1ebxb
Update to 3.4.0 stable release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
node_modules/cordova/_vendor/plugman/0.19.1-dev/README.md
75
75
      publish: [Function: publish],
76
76
      unpublish: [Function: unpublish],
77
77
      adduser: [Function: adduser],
78
 
      prepare: [Function: handlePrepare] }
 
78
      prepare: [Function: handlePrepare],
 
79
      create: [Function: create],
 
80
      platform: [Function: platform] }
79
81
 
80
82
### `install` method
81
83
 
165
167
    * module.exports = function(params, callback) {
166
168
    */
167
169
 
 
170
## Create plugin related actions
 
171
 
 
172
### `create` method
 
173
 
 
174
Creates basic scaffolding for a new plugin
 
175
 
 
176
  module.exports = function create( name, id, version, pluginPath, options, callback ) {...}
 
177
 
 
178
* `name` : a name for the plugin
 
179
* `id` : an id for the plugin
 
180
* `version` : a version for the plugin
 
181
* `pluginPath` : a path to create the plugin in
 
182
* `options` : an array of options
 
183
* `callback` : callback to invoke once complete. If specified, will pass in an error object as a first parameter if the action failed. If not and an error occurs, `plugman` will throw the error
 
184
 
 
185
### `platform` method
 
186
 
 
187
Add/Remove a platform from a newly created plugin
 
188
 
 
189
  module.exports = function platform( { operation: operation, platform_name: cli_opts.platform_name } );
 
190
 
 
191
* `operation` : "add or remove"
 
192
* `platform_name` : ios, android
 
193
 
168
194
## Example Plugins
169
195
 
170
196
- Google has a [bunch of plugins](https://github.com/MobileChromeApps/chrome-cordova/tree/master/plugins) which are maintained actively by a contributor to plugman