diff --git a/README.md b/README.md new file mode 100644 index 0000000..b2f4354 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# folktest +a simple test kit for myself and anyone else who doesn't feel like using jest or mocha or carrot or whatever the fuck its called + +# Usage +```js +import { it, assert } from 'folktest' + +const test = it('should pass', () => { + assert(true) +}) + +test() +/* { + * success: true, + * description: 'should pass', + * error: undefined + * } + */ + +const err = it('should error', () => { + assert(false) +}) + +err() +/* { + * success: false, + * description: 'should error', + * error: AssertionError('assertion error: false is not true') + * } + */ +``` + diff --git a/package.json b/package.json index faa9200..adfe4ec 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,10 @@ { "name": "folktest", + "author": "Rowan <rowan@kitsu.cafe> (https://kitsu.cafe)", "version": "1.0.0", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "keywords": [], - "author": "", - "license": "ISC", + "main": "src/index.js", + "scripts": { }, + "keywords": ["test"], + "license": "GPL-3.0-or-later", "description": "" }