Browse Source

[version] Updated docs and bumped version to 0.2.5

0.7.0-breaking-rewrite
Muthu Kumar 6 years ago
parent
commit
19e52d87e6
  1. 1
      .gitignore
  2. 17
      README.md
  3. 1
      hello.txt
  4. 2
      package.json

1
.gitignore

@ -2,3 +2,4 @@ node_modules
config.js
testsuite
app
strategies

17
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

1
hello.txt

@ -0,0 +1 @@
hello

2
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": {

Loading…
Cancel
Save