summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/resources/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'testing/web-platform/tests/resources/readme.md')
-rw-r--r--testing/web-platform/tests/resources/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/testing/web-platform/tests/resources/readme.md b/testing/web-platform/tests/resources/readme.md
new file mode 100644
index 000000000..eed909064
--- /dev/null
+++ b/testing/web-platform/tests/resources/readme.md
@@ -0,0 +1,23 @@
+## Introduction ##
+
+testharness.js provides a framework for writing low-level tests of
+browser functionality in javascript. It provides a convenient API for
+making assertions and is intended to work for both simple synchronous
+tests and for tests of asynchronous behaviour.
+
+## Getting Started ##
+
+To use testharness.js you must include two scripts, in the order given:
+
+``` html
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+```
+
+## Full documentation ##
+
+Full user documentation for the API is in the
+[docs/api.md](https://github.com/w3c/testharness.js/blob/master/docs/api.md) file.
+
+You can also read a tutorial on
+[Using testharness.js](http://darobin.github.com/test-harness-tutorial/docs/using-testharness.html).