# ContractCase Core

[![Build and test](https://github.com/case-contract-testing/contract-case/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/case-contract-testing/contract-case/actions/workflows/build-and-test.yml)
[![Coverage Status](https://coveralls.io/repos/github/case-contract-testing/contract-case/badge.svg?branch=main)](https://coveralls.io/github/case-contract-testing/contract-case?branch=main)
[![Known Vulnerabilities](https://snyk.io/test/github/case-contract-testing/contract-case/badge.svg?targetFile=packages/case-core/package.json)](https://snyk.io/test/github/case-contract-testing/contract-case?targetFile=packages/case-core/package.json)

[![npm](https://img.shields.io/npm/v/@contract-case/case-core.svg)](https://www.npmjs.com/package/@contract-case/case-core)

This is the core functionality for the [ContractCase Contract testing framework](https://case.contract-testing.io). If you want to use it, you probably want the [DSL package](https://www.npmjs.com/package/@contract-case/contract-case-jest) instead

<span align="center">

![Case](https://github.com/case-contract-testing/contract-case/raw/main/docs/suitcase.png)

<sub>[Briefcase sticker created by Gohsantosadrive on Flaticon](https://www.flaticon.com/free-stickers/law)</sub>

</span>

Read the [documentation here](https://case.contract-testing.io/docs/intro/).

You almost certainly want to install [this package](https://www.npmjs.com/package/@contract-case/contract-case-jest) instead.