Skip to content

Commit

Permalink
docs: update README file to add package introduction section
Browse files Browse the repository at this point in the history
  • Loading branch information
rainx committed Sep 23, 2023
1 parent 97eefc2 commit 1f82620
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@

<!-- Badges area end -->

## Introduction

This is a Mono repository contains a set of useful libraries/helpers in TypeScript.

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))

## Development

If you are confused about Develop and _README.md_, please see the document
Expand Down
2 changes: 1 addition & 1 deletion packages/exceptions/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It is inspired by the [PHP's SPL exceptions](https://www.php.net/manual/en/spl.e
## Installation

```bash
pnpm add @right/exceptions
pnpm add @rightcapital/exceptions
```

## Usage
Expand Down

0 comments on commit 1f82620

Please sign in to comment.