Updated Branches: refs/heads/dependencies 402bdf103 -> ab82a4248
Add spec for <dependency> tag to README.md. Project: http://git-wip-us.apache.org/repos/asf/cordova-plugman/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugman/commit/4fd115f3 Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugman/tree/4fd115f3 Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugman/diff/4fd115f3 Branch: refs/heads/dependencies Commit: 4fd115f39e3d65164dfb0c1ca214239e809391b9 Parents: 39d6f79 Author: Braden Shepherdson <[email protected]> Authored: Mon May 13 16:45:43 2013 -0400 Committer: Braden Shepherdson <[email protected]> Committed: Mon May 13 16:45:43 2013 -0400 ---------------------------------------------------------------------- README.md | 13 +++++++++++++ 1 files changed, 13 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-plugman/blob/4fd115f3/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index fa68ae9..833fb23 100644 --- a/README.md +++ b/README.md @@ -232,6 +232,19 @@ If `src` does not resolve to a file that can be found, plugman will stop/reverse <js-module> elements can also be nested under <platform>, to declare platform-specific JavaScript module bindings. +### <dependency> + +Dependency tags let you specify plugins on which this plugin depends. In the future there will be plugin repositories to fetch plugins from. In the short term, plugins are directly pointed to by URLs in `<dependency>` tags. These tags have the following format: + + <dependency id="com.plugin.id" src="https://github.com/myuser/someplugin"; commit="428931ada3891801" subdir="some/path/here" /> + +* `id`: gives the ID of the plugin. This should be globally unique, and in reverse-domain style. Neither of these restrictions is currently enforced, but they may be in the future and plugins should still follow them. +* `src`: A URL for the plugin. This should point to a git repository, since plugman will try to `git clone` it. +* `commit`: This is any git ref. It can be a branch or tag name (eg. `master`, `0.3.1`), a commit hash (eg. `975ddb228af811dd8bb37ed1dfd092a3d05295f9`), anything understood by `git checkout`. +* `subdir`: Specifies that the plugin we're interested in exists as a subdirectory of the git repository. This is helpful because it allows one to keep several related plugins in a sigle git repository, and specify the plugins in it individually. + +In the future, version constraints will be introduced, and a plugin repository will exist to support fetching by name instead of explicit URLs. + ### <platform> Platform tags identify platforms that have associated native code and/or require configuration file modifications. Tools using
