incubator-callback-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a...@apache.org
Subject [17/78] [abbrv] git commit: added plugin stuff to readme
Date Fri, 27 Jul 2012 00:29:15 GMT
added plugin stuff to readme


Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/commit/61782b87
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/tree/61782b87
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/diff/61782b87

Branch: refs/heads/cordova-client
Commit: 61782b876347c8446bd7e18b746b3e5be563b453
Parents: 30ed15c
Author: Fil Maj <maj.fil@gmail.com>
Authored: Tue Jul 17 18:18:29 2012 -0700
Committer: Fil Maj <maj.fil@gmail.com>
Committed: Tue Jul 17 18:18:29 2012 -0700

----------------------------------------------------------------------
 README.md |   39 ++++++++++++++++++++++++++++++++++-----
 1 files changed, 34 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/blob/61782b87/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c2019bf..3e6883f 100644
--- a/README.md
+++ b/README.md
@@ -83,17 +83,42 @@ project.
 
 ### Building Your Project
 
-    $ cordova build [platform]
+    $ cordova build
 
 You can call `cordova build` with no arguments if you are inside a cordova based project.
This will compile your app for all platforms added to your Cordova project.
 
 ### Emulating Your Project
 
-    $ cordova emulate [platform]
+    $ cordova emulate
 
-Will compile and launch your app on all platforms added to your
-Cordova project. You can optionally specify a specific platform to
-launch for.
+Will launch emulators for all platforms added to your
+Cordova project.
+
+### Managing Plugins
+
+Plugin integration hinges on:
+
+- You having the plugin code locally on your computer
+- The plugin code adheres to the [Cordova Plugin Specification](https://github.com/alunny/cordova-plugin-spec)
+
+#### Listing All Plugins
+
+    $ cordova plugin [ls]
+
+Lists out all plugins added to the current Cordova-based project.
+
+#### Adding A Plugin
+
+    $ cordova plugin add [path-to-plugin]
+
+Adds the platform as a build target for the current Cordova-based
+project.
+
+#### Removing A Plugin
+
+    $ cordova plugin remove [plugin]
+
+**NOT IMPLEMENTED!**
 
 # Examples
 
@@ -107,6 +132,10 @@ launch for.
 
     $ npm test
 
+**WARNING**: If you run tests and don't have any sub-directories under
+`./lib`, be prepared to see some failing tests as then this project will
+start cloning any necessary Cordova libraries (which may take a while).
+
 ## TO-DO
 
 - `grep` through this project for 'TODO'


Mime
View raw message