You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mm...@apache.org on 2014/05/06 21:45:28 UTC

git commit: Adding a Readme

Repository: cordova-labs
Updated Branches:
  refs/heads/cdvtest 8ae8e0336 -> cce7ca2ac


Adding a Readme


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

Branch: refs/heads/cdvtest
Commit: cce7ca2acdd7307888a2fb6081eb209151909198
Parents: 8ae8e03
Author: Michal Mocny <mm...@gmail.com>
Authored: Tue May 6 15:45:21 2014 -0400
Committer: Michal Mocny <mm...@gmail.com>
Committed: Tue May 6 15:45:21 2014 -0400

----------------------------------------------------------------------
 cordova-plugin-test-framework/README.md | 30 ++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-labs/blob/cce7ca2a/cordova-plugin-test-framework/README.md
----------------------------------------------------------------------
diff --git a/cordova-plugin-test-framework/README.md b/cordova-plugin-test-framework/README.md
index e69de29..8bc26d8 100644
--- a/cordova-plugin-test-framework/README.md
+++ b/cordova-plugin-test-framework/README.md
@@ -0,0 +1,30 @@
+Cordova Plugin Test Framework
+=============================
+
+This plugin attempts to establish a defacto standard for Apache Cordova plugin testing.
+
+How it works
+============
+
+The `org.apache.cordova.test-harness` plugin does two things:
+
+1. [Provides an interface to other plugins for defining jasmine-2.0 style auto tests, or custom manual tests](#interface)
+2. [Provides a test harness for running all plugin tests on your target device(s)](#harness)
+
+<a name="interface" />
+Testing Interface
+=================
+
+[`jasmine-2.0`](http://jasmine.github.io/2.0/introduction.html)
+
+<a name="harness" />
+Testing Harness
+===============
+
+Change the start page of you application, but adding this to your `config.xml`:
+
+```
+<content src="cdvtests/index.html" />
+```
+
+Now, when you run your app, you will start the test harness instead of your application.  At any point, switch back to application development by removing that line from your `config.xml`.