You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2015/03/14 03:51:42 UTC
cordova-plugin-test-framework git commit: CB-8653 Updated Readme
Repository: cordova-plugin-test-framework
Updated Branches:
refs/heads/master 114a42881 -> 6e46988a3
CB-8653 Updated Readme
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework/commit/6e46988a
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework/tree/6e46988a
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework/diff/6e46988a
Branch: refs/heads/master
Commit: 6e46988a3253b57015299e992b05d01e0e8eafef
Parents: 114a428
Author: Steve Gill <st...@gmail.com>
Authored: Fri Mar 13 19:51:36 2015 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Fri Mar 13 19:51:36 2015 -0700
----------------------------------------------------------------------
README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework/blob/6e46988a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index db69142..5f1503b 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@
# Cordova Plugin Test Framework
-The `org.apache.cordova.test-framework` plugin does two things:
+The `cordova-plugin-test-framework` plugin does two things:
1. [Defines the interface for cordova plugins to write tests](#interface)
2. [Provides a test harness for actually running those tests](#harness)
@@ -50,16 +50,16 @@ Tests run directly inside existing cordova projects, so you can rapidly switch b
### Where do tests live?
-Add a directory named `tests` to the root of your plugin. Within this directory, create a nested `plugin.xml` for the tests plugin. It should have a plugin id with the form `plugin-id.tests` (e.g. the `org.apache.cordova.device` plugin has the nested id `org.apache.cordova.device.tests`) and should contain a `<js-module>` named `tests`. E.g:
+Add a directory named `tests` to the root of your plugin. Within this directory, create a nested `plugin.xml` for the tests plugin. It should have a plugin id with the form `plugin-id-tests` (e.g. the `cordova-plugin-device` plugin has the nested id `cordova-plugin-device-tests`) and should contain a `<js-module>` named `tests`. E.g:
```
<js-module src="tests/tests.js" name="tests">
</js-module>
```
-For example, the `org.apache.cordova.device` plugin has this nested [`plugin.xml`](https://github.com/apache/cordova-plugin-device/blob/master/tests/plugin.xml).
+For example, the `cordova-plugin-device` plugin has this nested [`plugin.xml`](https://github.com/apache/cordova-plugin-device/blob/master/tests/plugin.xml).
-The `org.apache.cordova.test-framework` plugin will automatically find all `tests` modules across all plugins for which the nested tests plugin is installed.
+The `cordova-plugin-test-framework` plugin will automatically find all `tests` modules across all plugins for which the nested tests plugin is installed.
### Defining Auto Tests
@@ -117,7 +117,7 @@ Note: Your tests will automatically be labeled with your plugin id, so do not pr
<a name="example">
### Example
-See: [`org.apache.cordova.device` tests](https://github.com/apache/cordova-plugin-device/blob/master/tests/tests.js).
+See: [`cordova-plugin-device` tests](https://github.com/apache/cordova-plugin-device/blob/master/tests/tests.js).
<a name="harness" />
## Running Plugin Tests
@@ -133,7 +133,7 @@ See: [`org.apache.cordova.device` tests](https://github.com/apache/cordova-plugi
## FAQ
-* Q: Should I add `org.apache.cordova.test-framework` as a `<dependency>` of my plugin?
+* Q: Should I add `cordova-plugin-test-framework` as a `<dependency>` of my plugin?
* A: No. The end-user should decide if they want to install the test framework, not your plugin (most users won't).
* Q: What do I do if my plugin tests must have very large assets?
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org