Merge pull request #34 from RightCapitalHQ/feature/update-readme-docs

docs: update README files to add API Reference link for new packages
RightCapitalHQ · Oct 25, 2023 · 9da50d5 · 9da50d5
2 parents 423a222 + 72d48e3
commit 9da50d5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,8 @@ This is a Mono repository contains a set of useful libraries/helpers in TypeScri
 
 it including the following packages:
 
-- @rightcapital/exceptions: This library provides a set of standard Exceptions ([docs](https://github.com/RightCapitalHQ/frontend-libraries/tree/main/packages/exceptions/docs))
+- @rightcapital/exceptions: This library provides a set of standard Exceptions ([API Reference](https://github.com/RightCapitalHQ/frontend-libraries/tree/main/packages/exceptions/docs))
+- @rightcapital/date-helpers: A utility class providing various date formatting and parsing methods in TypeScript. ([API Reference](https://github.com/RightCapitalHQ/frontend-libraries/blob/main/packages/date-helpers/docs/modules.md))
 
 ## Development
 

diff --git a/change/@rightcapital-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json b/change/@rightcapital-exceptions-750cd51a-cc98-405e-af90-0a155313368b.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "docs: update README files to add API Reference link for new packages",
+  "packageName": "@rightcapital/exceptions",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/exceptions/README.md b/packages/exceptions/README.md
@@ -37,6 +37,6 @@ try {
 }
 ```
 
-## Modules
+## API Reference
 
 [Here](/packages/exceptions/docs/modules.md) is the API documentation for the modules included in the package.