chore: Update Readme.md to include badges and link to typedoc (#13)

core/README.md

@@ -1,5 +1,11 @@
 # Core Module
 
+![GitHub Workflow Status (main)](https://img.shields.io/github/actions/workflow/status/nevware21/tripwire/ci.yml?branch=main)
+[![codecov](https://codecov.io/gh/nevware21/tripwire/graph/badge.svg?token=I9mMGSvfkk)](https://codecov.io/gh/nevware21/tripwire)
+[![npm version](https://badge.fury.io/js/%40nevware21%2Ftripwire.svg)](https://badge.fury.io/js/%40nevware21%2Ftripwire)
+[![downloads](https://img.shields.io/npm/dt/%40nevware21/tripwire.svg)](https://www.npmjs.com/package/%40nevware21/tripwire)
+[![downloads](https://img.shields.io/npm/dm/%40nevware21/tripwire.svg)](https://www.npmjs.com/package/%40nevware21/tripwire)
+
 This is the core module of the `tripwire` project which is designed to be used for testing your Javascript or TypeScript packages.
 
 It is designed to work in and is tested with the following environments.
@@ -16,6 +22,10 @@ The `assert` functions are built on-top of the underlying `expect` support, and
 
 To avoid dependency issues, this project will use the mininal set of external dependencies so that it can ensure and maintain compatibility with current (and future) runtimes.
 
+## API Documentation
+
+The API documentation is generated from the source code via typedoc and is located [here](https://nevware21.github.io/tripwire/index.html)
+
 ## Quick Start
 
 Install the npm packare: `npm install @nevware21/tripwire --save-dev`

shim/chai/README.md

@@ -1,5 +1,11 @@
 # Chai Shim
 
+![GitHub Workflow Status (main)](https://img.shields.io/github/actions/workflow/status/nevware21/tripwire/ci.yml?branch=main)
+[![codecov](https://codecov.io/gh/nevware21/tripwire/graph/badge.svg?token=I9mMGSvfkk)](https://codecov.io/gh/nevware21/tripwire)
+[![npm version](https://badge.fury.io/js/%40nevware21%2Ftripwire-chai.svg)](https://badge.fury.io/js/%40nevware21%2Ftripwire-chai)
+[![downloads](https://img.shields.io/npm/dt/%40nevware21/tripwire-chai.svg)](https://www.npmjs.com/package/%40nevware21/tripwire-chai)
+[![downloads](https://img.shields.io/npm/dm/%40nevware21/tripwire-chai.svg)](https://www.npmjs.com/package/%40nevware21/tripwire-chai)
+
 This module is a Shim of the Chai Js assertion library which uses the [tripwire](https://github.com/nevware21/tripwire)
 
 This Shim is not designed to be a complete 1:1 replacement for Chai, it's primary focus is to provide a quicker migration option using your existing chai based `assert.*` functions.
@@ -21,13 +27,9 @@ As of the initial version not all functions are yet implemented
 - `should` (No plans to implement this)
 - plugin support
 
-## Table of Contents
+## API Documentation
 
-- Installation
-- Usage
-- Scripts
-- Contributing
-- License
+The API documentation is generated from the source code via typedoc and is located [here](https://nevware21.github.io/tripwire/index.html)
 
 ## Quickstart