diff --git a/README.md b/README.md index 9f26eff..a600855 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,9 @@ XXX - [Architecture](#architecture) - [Combinational testing](#combinational-testing) - [Unit testing](#unit-testing) + - [Installation](#installation) - [Basic usage](#basic-usage) + - [CLI](#cli) - [Components](#components) - [`DEFAULT_TEST_FILES`](#default_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. +## Installation + +```shell_session +npm install -g ig-test +``` + +```shell_session +npm install -i ig-test +``` + + ## Basic usage +XXX script naming... + +Create a test script ```shell_session $ touch test.js $ chmod +x test.js @@ -97,6 +113,8 @@ The code: var test = require('ig-test') +// XXX add assert examples... + test.Setups({ state: function(assert){ return { @@ -128,14 +146,22 @@ __filename == (require.main || {}).filename Run the tests ```shell_session -$ runtests +$ node ./test.js ``` or ```shell_session -$ node ./test.js +$ runtests ``` +## CLI + +XXX help + +XXX chains + +XXX notes on coverage + ## Components diff --git a/package.json b/package.json index 3da6435..d781a92 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ig-test", - "version": "1.4.1", + "version": "1.4.2", "description": "experimental test runner....", "main": "test.js", "bin": {