test-sweet/README.md

A sweet test suite for javascript

# Sweet Test Framework

This is a sweet as javascript test framework.

## Setup
First install the package globally
```
npm install -g test-sweet
```
To use in a local project, if the project hasn't been initialised:
```
npm init
```
Then install locally in the root of your project
```
npm install test-sweet
```
Put test files in a folder called spec in your project root

Ensure your test files end with spec.js or test.js

Add at the top of each test file: ```require('test-sweet') ```

To run tests in the terminal run:
```
sweet
```

## Descriptors
```
represent
describe
method
it
```

## Assertions
```
expect
allow
```

## Matchers
```
toEqual
toInclude
toBeGreaterThan
toBeLessThan
isInstanceOf
```

## Contributors
<img src="https://avatars2.githubusercontent.com/u/40716695?s=400&u=2995577c59d4e99096a74613d629e89bff104cee&v=4" width="50px;"/> Alfie Freeman </img>
<img src="https://avatars3.githubusercontent.com/u/36574210?s=400&v=4" width="50px;"/> Robin Johnson </img>


## License
ISC