more work on docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2020-08-19 01:42:57 +03:00
parent 207ac3802f
commit 1415d45de6
2 changed files with 29 additions and 3 deletions

View File

@ -13,7 +13,9 @@ XXX
- [Architecture](#architecture) - [Architecture](#architecture)
- [Combinational testing](#combinational-testing) - [Combinational testing](#combinational-testing)
- [Unit testing](#unit-testing) - [Unit testing](#unit-testing)
- [Installation](#installation)
- [Basic usage](#basic-usage) - [Basic usage](#basic-usage)
- [CLI](#cli)
- [Components](#components) - [Components](#components)
- [`DEFAULT_TEST_FILES`](#default_test_files) - [`DEFAULT_TEST_FILES`](#default_test_files)
- [`IGNORE_TEST_FILES`](#ignore_test_files) - [`IGNORE_TEST_FILES`](#ignore_test_files)
@ -84,8 +86,22 @@ This makes it simple to define procedural/generative tests.
This is the traditional self-contained test approach. This is the traditional self-contained test approach.
## Installation
```shell_session
npm install -g ig-test
```
```shell_session
npm install -i ig-test
```
## Basic usage ## Basic usage
XXX script naming...
Create a test script
```shell_session ```shell_session
$ touch test.js $ touch test.js
$ chmod +x test.js $ chmod +x test.js
@ -97,6 +113,8 @@ The code:
var test = require('ig-test') var test = require('ig-test')
// XXX add assert examples...
test.Setups({ test.Setups({
state: function(assert){ state: function(assert){
return { return {
@ -128,14 +146,22 @@ __filename == (require.main || {}).filename
Run the tests Run the tests
```shell_session ```shell_session
$ runtests $ node ./test.js
``` ```
or or
```shell_session ```shell_session
$ node ./test.js $ runtests
``` ```
## CLI
XXX help
XXX chains
XXX notes on coverage
## Components ## Components

View File

@ -1,6 +1,6 @@
{ {
"name": "ig-test", "name": "ig-test",
"version": "1.4.1", "version": "1.4.2",
"description": "experimental test runner....", "description": "experimental test runner....",
"main": "test.js", "main": "test.js",
"bin": { "bin": {