add readme and package.json

This commit is contained in:
Rowan 2025-03-26 20:00:44 -05:00
parent 96ce863f7f
commit aafe014252
2 changed files with 37 additions and 7 deletions

32
README.md Normal file
View file

@ -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')
* }
*/
```

View file

@ -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": ""
}