Skip to content

Commit

Permalink
docs: adds library documentation and steps to contribute (#13)
Browse files Browse the repository at this point in the history
* docs: adds complete documentation

* docs: adds contributing instructions

---------

Co-authored-by: Harsh Kumar Choudhary <harsh.choudhary@HARSH-CHOUDHARY-MAC.local>
  • Loading branch information
harshkc and Harsh Kumar Choudhary authored Mar 15, 2024
1 parent 33f74ff commit c57caa7
Show file tree
Hide file tree
Showing 2 changed files with 429 additions and 1 deletion.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing to the Project

Thank you for your interest in contributing to the project! Here are the steps to get started:

## Installation

1. Make sure you have [pnpm](https://pnpm.io/) installed on your system.
2. Open a terminal and navigate to the project directory.
3. Run the following command to install all the dependencies:

```shell
pnpm install
```

## Building the Project

Once the dependencies are installed, you can build the project using the following command:

```shell
pnpm build
```

## Running the tests

To run the tests, build the project and then open index.html in your browser. It will run the tests and display the results.
Loading

0 comments on commit c57caa7

Please sign in to comment.