Skip to content

Commit

Permalink
Editorial: Update README.md
Browse files Browse the repository at this point in the history
Improve prose for resources (i.e., `testharness.js`).

I have been educating the community on the benefits of aligning testing
with WPT. However, testharness is a little difficult to get head wrapped around
from the feedback I am receiving. Also have recently been doing some prose
updates in documentation over @ WHATWG. I am revisiting the WPT setup process
and believe one should always leave code better than when they saw it.

References:
  - whatwg/meta#48
  - (in particular) whatwg/meta#48 (comment)
  • Loading branch information
snuggs committed Nov 10, 2017
1 parent 2dfdda4 commit 0d693af
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions resources/readme.md
Original file line number Diff line number Diff line change
@@ -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:

``` 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
[Using testharness.js](http://darobin.github.com/test-harness-tutorial/docs/using-testharness.html).

0 comments on commit 0d693af

Please sign in to comment.