Add examples

Author: sophiebremer

Diff for: README.md

@@ -2,3 +2,63 @@ TST: TypeScript Tester
 ======================
 
 Simple testing tool to run and test TypeScript code in combination with assertion libraries.
+
+
+
+Command Line Arguments
+----------------------
+
+* \[options] : Optional flags explained in the section below.
+
+* \[source]  : Source folder with TypeScript tests.
+
+
+
+Command Line Options
+--------------------
+
+* --help, -h    : Prints this help text.
+
+* --only [path] : Runs a single test in [source].
+
+* --verbose     : Prints this help text.
+
+* --version, -v : Prints the version string.
+
+
+
+Examples
+--------
+
+Import the default test function in the following pattern. If you like to use a
+custom assert library, you can ignore the assert argument.
+
+```ts
+import test from '@typescriptlibs/tst';
+
+test('Test the answer to the ultimate question.', (assert: test.Assert) => {
+    assert.strictEqual(
+        42,
+        Math.cbrt(74088),
+        'The answer to the ultimate question should be the cube root of 74088.'
+    );
+});
+
+test('Test the timeout function.', async (assert: test.Assert) => {
+    const time = Date.now();
+
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const delta = Date.now() - time;
+
+    assert.ok(
+        delta > 100,
+        `The timeout should fire after 100 milliseconds. (${delta})`
+    );
+});
+```
+
+Compiles, loads and runs assertion tests in the "tests" folder.
+```sh
+$ tst tests/
+```

Diff for: tst/CLI.ts

@@ -12,7 +12,7 @@ import test, { CLI, System } from '@typescriptlibs/tst';
  *
  * */
 
-test('CLI tests', function (assert: test.Assert) {
+test('CLI tests', (assert: test.Assert) => {
     assert.strictEqual(
         CLI.VERSION,
         `Version ${System.VERSION}`,

Diff for: tst/Examples.ts

@@ -0,0 +1,22 @@
+import test from '@typescriptlibs/tst';
+
+test('Test the answer to the ultimate question.', (assert: test.Assert) => {
+    assert.strictEqual(
+        42,
+        Math.cbrt(74088),
+        'The answer to the ultimate question should be the cube root of 74088.'
+    );
+});
+
+test('Test the timeout function.', async (assert: test.Assert) => {
+    const time = Date.now();
+
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const delta = Date.now() - time;
+
+    assert.ok(
+        delta > 100,
+        `The timeout should fire after 100 milliseconds. (${delta})`
+    );
+});

Diff for: tst/System.ts

@@ -12,7 +12,7 @@ import test, { System } from '@typescriptlibs/tst';
  *
  * */
 
-test('System tests', function (assert: test.Assert) {
+test('System tests', (assert: test.Assert) => {
     assert.ok(
         System.VERSION.match(/^\d+\.\d+\.\d+$/),
         'System.VERSION should be a version string.'

Diff for: tst/Tester.ts

@@ -12,7 +12,7 @@ import test, { Tester } from '@typescriptlibs/tst';
  *
  * */
 
-test('Tester tests', function (assert: test.Assert) {
+test('Tester tests', (assert: test.Assert) => {
     assert.ok(
         typeof Tester === 'function',
         'Tester should be a class constructor.'