From c7012cf92f37d7ac49cb5ef4f9c470aa331f17fe Mon Sep 17 00:00:00 2001
From: web-mech <webmech@gmail.com>
Date: Sat, 17 Aug 2024 20:43:01 -0400
Subject: [PATCH] docs(readme): update readme

update api section. add links to typedoc docs. update test status badge
---
 README.md | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index a3e0335..9091c4f 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,10 @@
 
 A javascript filter for badwords
 
+[![Testing Testing](https://github.com/web-mech/badwords/actions/workflows/test.yml/badge.svg)](https://github.com/web-mech/badwords/actions/workflows/test.yml)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
+[![TypeDoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](https://web-mech.github.io/badwords/)
 
 ## Requirements
 
@@ -89,17 +91,13 @@ filter.removeWords(...removeWords)
 filter.clean('some sadist hells word!') //some sadist hells word!
 ```
 
-#### Table of Contents
+## API Reference
 
-## API
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
+Check out [!TypeDoc Documentation](https://web-mech.github.io/badwords/)
 
 ## Testing
 
-    npm test
+    yarn test
 
 ## License