updated readme and package.json
authorSteve Gill <stevengill97@gmail.com>
Tue, 23 Aug 2016 23:19:03 +0000 (16:19 -0700)
committerSteve Gill <stevengill97@gmail.com>
Tue, 23 Aug 2016 23:19:03 +0000 (16:19 -0700)
README.md
package.json

index bc18760..32558fb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@
 
 # cordova-create
 
-This module is used for creating cordova style projects. 
+This module is used for creating cordova style projects. It also incudes support for [cordova templates](http://cordova.apache.org/docs/en/latest/guide/cli/template.html). It can fetch templates from npm and git.
 
 ## Usage:
 :
@@ -39,3 +39,17 @@ create(dir, id, name, cfg, extEvents);
  `name` - app name. Required (but can be "undefined"). 
  `cfg` - extra config to be saved in .cordova/config.json Required (but can be "{}").
  `extEvents` - An EventEmitter instance that will be used for logging purposes. Required (but can be "undefined").
+
+An example of cfg which would fetch a cordova template from npm (or git):
+
+```
+var cfg = {
+    lib: {
+        www: {
+            template: true,
+            url: 'cordova-app-hello-world',
+            version: ''
+        }
+    }
+};
+```
index 5d08493..6a83925 100644 (file)
@@ -25,7 +25,7 @@
   },
   "engineStrict": true,
   "dependencies": {
-    "cordova-app-hello-world": "3.10.0",
+    "cordova-app-hello-world": "^3.10.0",
     "cordova-common": "^1.4.0",
     "cordova-fetch": "^1.0.0",
     "q": "1.0.1",
     {
       "name": "Caryn Tran",
       "email": "caryn.tran@berkeley.edu"
+    },
+    {
+      "name": "Steve Gill",
+      "email": "stevengill97@gmail.com"
     }
   ]
 }