From e7415c4c9634de194e3cfae2637c079c512c1413 Mon Sep 17 00:00:00 2001 From: Jonatan Nilsson Date: Fri, 19 Feb 2016 05:43:37 +0000 Subject: [PATCH] README: Update with description and methods --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bd8238..4f83f29 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # assert-extended -Core assert library extended slightly with few more assertion methods +A complimenting library for `require('assert')` with a few more assertions being made available. + +# Installation + +``` +npm install assert-extended --save-dev +``` + +# Usage + +Add the following anywhere in your test: + +``` +require('assert-extended'); +``` + +And you're good to go. + +# Assert + +Including the default ones that come with `assert` the following are added: + +### assert.notOk(value, message) + +Asserts value is a falsy value. + +### assert.isFulfilled(promise, message) + +Asserts that the promise is fulfilled. + +### assert.isRejected(promise, message) + +Asserts that the promise is rejected. + +### assert.match(value, test, message) + +Asserts that the value RexExp matches the test.