added readme and releasenotes
authorSteve Gill <stevengill97@gmail.com>
Wed, 20 Jul 2016 20:59:30 +0000 (13:59 -0700)
committerSteve Gill <stevengill97@gmail.com>
Wed, 20 Jul 2016 21:01:46 +0000 (14:01 -0700)
README.md [new file with mode: 0644]
RELEASENOTES.md [new file with mode: 0644]
spec/create.spec.js

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3429c63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+
+[![Build status](https://ci.appveyor.com/api/projects/status/pejqbhscb3mlnt74)](https://ci.appveyor.com/project/stevengill/cordova-create)
+[![Build Status](https://travis-ci.org/stevengill/cordova-create.svg?branch=master)](https://travis-ci.org/stevengill/cordova-create)
+
+# cordova-create
+
+This module is used for creating cordova style projects. 
+
+## Usage:
+:
+```
+var create = require('cordova-create');
+
+create(dir, id, name, cfg, extEvents);
+```
+
+ `dir` - directory where the project will be created. Required.
+ `id` - app id. Required (but can be "undefined").
+ `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").
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
new file mode 100644 (file)
index 0000000..2b12d56
--- /dev/null
@@ -0,0 +1,23 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+# Cordova-create Release Notes
+
+
index 9d5cfa8..8ad0693 100644 (file)
@@ -77,7 +77,7 @@ describe('cordova create checks for valid-identifier', function() {
             expect(err.message).toBe('App id contains a reserved word, or is not a valid identifier.');
         })
         .fin(done);
-    });
+    }, 60000);
     
     it('should reject reserved words from end of id', function(done) {
         create('projectPath', 'bob.class', 'appName')
@@ -85,7 +85,7 @@ describe('cordova create checks for valid-identifier', function() {
             expect(err.message).toBe('App id contains a reserved word, or is not a valid identifier.');
         })
         .fin(done);
-    });
+    }, 60000);
 });
 
 
@@ -207,7 +207,7 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
         })
         .fin(done);
-    }, 10000);
+    }, 60000);
     
     it('should successfully run with template not having a package.json at toplevel', function(done) {
         // Call cordova create with no args, should return help.
@@ -233,7 +233,7 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
         })
         .fin(done);
-    });
+    }, 60000);
     
     it('should successfully run with template having package.json and no sub directory', function(done) {
         // Call cordova create with no args, should return help.
@@ -254,7 +254,7 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
         })
         .fin(done);
-    });
+    }, 60000);
     
     it('should successfully run with template having package.json, and subdirectory, and no package.json in subdirectory', function(done) {
         // Call cordova create with no args, should return help.
@@ -276,7 +276,7 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
         })
         .fin(done);
-    });
+    }, 60000);
 
 
     it('should successfully run with template having package.json, and subdirectory, and package.json in subdirectory', function(done) {
@@ -291,7 +291,7 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
         })
         .fin(done);
-    });
+    }, 60000);
 
     it('should successfully run config.xml in the www folder and move it outside', function(done) {
         // Call cordova create with no args, should return help.
@@ -306,7 +306,7 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
         })
         .fin(done);
-    });
+    }, 60000);
 
     it('should successfully run with www folder as the template', function(done) {
         var config = {
@@ -326,6 +326,6 @@ describe('create end-to-end', function() {
             expect(err).toBeUndefined();
          })
         .fin(done);
-    });
+    }, 60000);
 
 });