Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,8 @@ You must have `git` on your PATH to be able to install plugins directly from rem

## Supported Platforms

* Amazon Fire OS
* Android
* BlackBerry 10
* iOS
* Tizen
* Windows Phone 8
* Windows 8

## Command Line Usage
Display all available plugman commands:
Expand All @@ -65,11 +60,11 @@ Display all available plugman commands:

Install a plugin into a Cordova project:

plugman install --platform <ios|amazon-fireos|android|blackberry10|wp8> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]
plugman install --platform <ios|android> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]

Uninstall a Plugin from a Cordova project:

plugman uninstall --platform <ios|amazon-fireos|android|blackberry10|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
plugman uninstall --platform <ios|android> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]

For each command (install and uninstall), you must specify a platform and Cordova project location for that platform. You also must specify a plugin, with the different `--plugin` parameter forms being:

Expand Down Expand Up @@ -127,7 +122,7 @@ This section details how to consume Plugman as a node module and is only for Cor

Installs a plugin into a specified cordova project of a specified platform.

* `platform`: one of `amazon-fireos`, `android`, `ios`, `blackberry10`, or `wp8`
* `platform`: `android` or `ios`
* `project_dir`: path to an instance of the above specified platform's cordova project
* `id`: a string representing the `id` of the plugin, a path to a cordova plugin with a valid `plugin.xml` file, or an `https://` or `git://` url to a git repository of a valid cordova plugin or a plugin published to the Cordova registry
* `plugins_dir`: path to directory where plugins will be stored, defaults to `<project_dir>/cordova/plugins`
Expand All @@ -142,7 +137,7 @@ Installs a plugin into a specified cordova project of a specified platform.

Uninstalls a previously-installed cordova plugin from a specified cordova project of a specified platform.

* `platform`: one of `amazon-fireos`, `android`, `ios`, `blackberry10`, or `wp8`
* `platform`: `android` or `ios`
* `project_dir`: path to an instance of the above specified platform's cordova project
* `id`: a string representing the `id` of the plugin
* `plugins_dir`: path to directory where plugins are stored, defaults to `<project_dir>/cordova/plugins`
Expand Down Expand Up @@ -171,7 +166,7 @@ Finalizes plugin installation by making configuration file changes and setting u
module.exports = function handlePrepare(project_dir, platform, plugins_dir) {

* `project_dir`: path to an instance of the above specified platform's cordova project
* `platform`: one of `amazon-fireos`, `android`, `ios`, `blackberry10`, or `wp8`
* `platform`: `android` or `ios`
* `plugins_dir`: path housing all plugins used in this project

## Registry related actions
Expand Down Expand Up @@ -237,7 +232,6 @@ Add/Remove a platform from a newly created plugin

- Google has a [bunch of plugins](https://github.com/MobileChromeApps/mobile-chrome-apps/tree/master/chrome-cordova/plugins) which are maintained actively by a contributor to plugman
- Adobe maintains plugins for its Build cloud service, which are open sourced and [available on GitHub](https://github.com/phonegap-build)
- BlackBerry has a [bunch of plugins](https://github.com/blackberry/cordova-blackberry/tree/master/blackberry10/plugins) offering deep platform integration
- Core and 3rd party plugins can be found on the [Cordova Registry](http://plugins.cordova.io).

## Development
Expand Down
Loading