diff --git a/.gitignore b/.gitignore index 58e1c82..8d9e472 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ node_modules config.js testsuite -app \ No newline at end of file +app +strategies \ No newline at end of file diff --git a/README.md b/README.md index 2386ba5..f49cd2f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ > Gunner is a zero magic, fast test-runner and assertion framework. There are no magic globals or CLI specific interface. -## Usage +## Requirements & Usage + +`Gunner` uses very modern JavaScript, and hence requires node 10+ currently. Create a new `Gunner` instance and simply write your tests. The assertion methods are passed in as the callback to the test function. @@ -22,16 +24,19 @@ gunner.run(); ## API ---- -### [new Gunner(options)](#gunner-constructor) -### [Gunner#test(title, implementation)](#gunnertest) -### [Gunner#run(options)](#gunnerrun) +#### [Gunner.constructor](#new-gunner) +#### [Gunner#test(title, implementation)](#gunnertest) +#### [Gunner#run(options)](#gunnerrun) --- -### Gunner constructor +### new Gunner Creates a new Gunner instance. +#### Options + +- **`name`** [default: undefined]: A name for this Gunner instance. + #### Usage ```JavaScript diff --git a/hello.txt b/hello.txt new file mode 100644 index 0000000..b6fc4c6 --- /dev/null +++ b/hello.txt @@ -0,0 +1 @@ +hello \ No newline at end of file diff --git a/package.json b/package.json index 00efca9..bb3f93d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@klenty/gunner", - "version": "0.2.1", + "version": "0.2.5", "description": "Zero magic, fast test-runner and assertion framework. No magic globals.", "main": "index.js", "repository": {