aboutsummaryrefslogtreecommitdiffstats
path: root/tests/wpt/web-platform-tests/resources/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/wpt/web-platform-tests/resources/readme.md')
-rw-r--r--tests/wpt/web-platform-tests/resources/readme.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/tests/wpt/web-platform-tests/resources/readme.md b/tests/wpt/web-platform-tests/resources/readme.md
index 8583d5f8d5b..8cf95b4052a 100644
--- a/tests/wpt/web-platform-tests/resources/readme.md
+++ b/tests/wpt/web-platform-tests/resources/readme.md
@@ -1,22 +1,26 @@
-## Introduction ##
+# Resources
-testharness.js provides a framework for writing low-level tests of
+## `testharness.js`
+
+`testharness.js` is 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.
+tests, and tests of asynchronous behaviour.
-## Getting Started ##
+### Getting started
-To use testharness.js you must include two scripts, in the order given:
+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>
+<script src=/resources/testharness.js></script>
+<script src=/resources/testharnessreport.js></script>
```
-## Full documentation ##
+### Full documentation
+
+For detailed API documentation please visit [http://web-platform-tests.org/writing-tests/testharness-api.html](http://web-platform-tests.org/writing-tests/testharness-api.html).
-Full user documentation for the API is at [http://web-platform-tests.org/writing-tests/testharness-api.html](http://web-platform-tests.org/writing-tests/testharness-api.html).
+### Tutorials
-You can also read a tutorial on
+You can also read a tutorial on
[Using testharness.js](http://darobin.github.com/test-harness-tutorial/docs/using-testharness.html).