incubator-callback-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fil...@apache.org
Subject git commit: worked out the readme regarding hooks/events
Date Sat, 06 Oct 2012 02:03:27 GMT
Updated Branches:
  refs/heads/cordova-client 3cb56db67 -> f6b40337e


worked out the readme regarding hooks/events


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/f6b40337
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/tree/f6b40337
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/diff/f6b40337

Branch: refs/heads/cordova-client
Commit: f6b40337e6cad0a49f3f4501c4a7221c8e411ade
Parents: 3cb56db
Author: Fil Maj <maj.fil@gmail.com>
Authored: Fri Oct 5 19:03:18 2012 -0700
Committer: Fil Maj <maj.fil@gmail.com>
Committed: Fri Oct 5 19:03:18 2012 -0700

----------------------------------------------------------------------
 README.md |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cordova-labs/blob/f6b40337/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 812bd51..0acdb8d 100644
--- a/README.md
+++ b/README.md
@@ -80,7 +80,15 @@ This file is what you should be editing to modify your application's metadata.
A
 
 # Hooks
 
-Projects created by cordova-client have `before` and `after` hooks for each [project command](#project_commands).
These are located under the `.cordova/hooks` directory in the root of your cordova project.
Any scripts you add to these directories will be executed before and after the appropriate
commands. Useful for integrating your own build systems or integrating with version control
systems. __Remember__: make your scripts executable.
+Projects created by cordova-client have `before` and `after` hooks for each [project command](#project_commands).
There are two types of hooks: project-specific ones and module-level ones.
+
+## Project-specific Hooks
+
+These are located under the `.cordova/hooks` directory in the root of your cordova project.
Any scripts you add to these directories will be executed before and after the appropriate
commands. Useful for integrating your own build systems or integrating with version control
systems. __Remember__: make your scripts executable.
+
+## Module-level Hooks
+
+If you are using cordova-client as a module within a larger node application, you can also
use the standard `EventEmitter` methods to attach to the events. The events include `before_build`,
`before_docs`, `before_emulate`, `before_platform_add`, `before_platform_ls`, `before_platform_rm`,
`before_plugin_add`, `before_plugin_ls` and `before_plugin_rm`. Additionally, there are `after_`
flavours of all the above events.
 
 # Examples
 


Mime
View raw message