From 357cc480beb4a2deb831259f126b0692d73f66ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sun, 21 Apr 2019 02:00:42 -0400 Subject: [PATCH] Add a table of contents to the README --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c029456..bb237e5 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,23 @@ const { chai.use(require('./chai-immutable')); --> +## Assertions + +- BDD API Reference (Expect / Should) + - [`.empty`](#empty) + - [`.equal(collection)`](#equalcollection) + - [`.referenceEqual(value)`](#referenceequalvalue) + - [`.include(value)`](#includevalue) + - [`.keys(key1[, key2[, ...]])`](#keyskey1-key2-) + - [`.property(path[, val])`](#propertypath-val) + - [`.size(value)`](#sizevalue) +- TDD API Reference (Assert) + - [`.equal(actual, expected)`](#equalactual-expected) + - [`.referenceEqual(actual, expected)`](#referenceequalactual-expected) + - [`.notEqual(actual, expected)`](#notequalactual-expected) + - [`.notReferenceEqual(actual, expected)`](#notreferenceequalactual-expected) + - [`.sizeOf(collection, length)`](#sizeofcollection-length) + ## Installation ### Node.js @@ -95,7 +112,7 @@ expect(Promise.resolve(List.of(1, 2, 3))).to.eventually.have.size(3); expect(true).to.be.true(); ``` -## BDD API Reference +## BDD API Reference (Expect / Should) ### .empty @@ -365,7 +382,7 @@ Similarly to `length`/`lengthOf`, `sizeOf` is an alias of `size`: expect(List.of(1, 2, 3)).to.have.sizeOf(3); ``` -## TDD API Reference +## TDD API Reference (Assert) ### .equal(actual, expected)